Skip to main content

​
List webhooks

Retrieve all webhook endpoints configured for a community. 
GET /v1/communities/:community_id/webhooks

​
Create webhook

Register a new webhook endpoint to receive real-time event notifications. 
POST /v1/communities/:community_id/webhooks
Request body: 
{
  "url": "https://your-server.com/webhook",
  "events": ["member.joined", "payment.completed"],
  "is_active": true
}
FieldTypeRequiredDescription
urlstringYesThe HTTPS endpoint URL that will receive webhook payloads.
eventsstring[]YesArray of event types to subscribe to.
is_activebooleanNoWhether the webhook is active (default: true).
For the full list of available event types, see the Webhooks integration guide.

​
Update webhook

Update the URL, subscribed events, or active status of an existing webhook. 
PATCH /v1/communities/:community_id/webhooks/:id
Request body: Any subset of the fields from Create webhook.

​
Delete webhook

Permanently delete a webhook endpoint. It will stop receiving events immediately. 
DELETE /v1/communities/:community_id/webhooks/:id

​
Test webhook

Send a test event to a webhook endpoint to verify connectivity. The test payload uses the test.ping event type. 
POST /v1/communities/:community_id/webhooks/:id/test
Response: Returns the HTTP status code and response time from your endpoint.
Use this endpoint after creating or updating a webhook to confirm your server is receiving and acknowledging payloads correctly.

​
Webhook logs

Retrieve the delivery log for a specific webhook endpoint. Use this to debug failed deliveries or inspect past payloads. 
GET /v1/communities/:community_id/webhooks/:id/logs
Query parameters:
ParameterTypeDescription
pageintPage number (default: 1).
per_pageintItems per page (max 50).
Response: 
{
  "data": [
    {
      "id": "uuid",
      "event": "member.joined",
      "status_code": 200,
      "response_time_ms": 150,
      "created_at": "2025-01-20T10:00:00Z"
    }
  ]
}
FieldTypeDescription
idstringUnique log entry ID.
eventstringThe event type that was delivered.
status_codeintHTTP status code returned by your endpoint.
response_time_msintRound-trip response time in milliseconds.
created_atstringISO 8601 timestamp of the delivery attempt.