Webhooks

Overview

This set of endpoints allows you to do all kinds of operations on your community webhooks. Learn more about how webhooks work and which events are available on our product documentation.

API Reference

List all webhooks of your community

get

/public/communities/{subdomain}/webhooks

Path parameters
subdomainstringrequired
Header parameters
x-api-keystringrequired
Responses
curl -L \
  --url 'https://api-v2.zealy.io/public/communities/{subdomain}/webhooks' \
  --header 'x-api-key: text'
{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "uri": "https://example.com",
      "communityId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-02-19T03:09:42.355Z",
      "updatedAt": "2025-02-19T03:09:42.355Z",
      "active": true,
      "secret": "text",
      "success": 1,
      "failed": 1,
      "exhausted": 1,
      "events": [
        "JOINED_COMMUNITY"
      ]
    }
  ]
}

Create a new webhook

post

/public/communities/{subdomain}/webhooks

Path parameters
subdomainstringrequired
Header parameters
x-api-keystringrequired
Body
namestringrequired
uristring urirequired
activebooleanrequired
eventsenum[]required
Responses
curl -L \
  --request POST \
  --url 'https://api-v2.zealy.io/public/communities/{subdomain}/webhooks' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","uri":"https://example.com","active":true,"events":["JOINED_COMMUNITY"]}'
{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Delete a webhook

delete

/public/communities/{subdomain}/webhooks/{webhookId}

Path parameters
webhookIdstring uuidrequired
subdomainstringrequired
Header parameters
x-api-keystringrequired
Responses
curl -L \
  --request DELETE \
  --url 'https://api-v2.zealy.io/public/communities/{subdomain}/webhooks/{webhookId}' \
  --header 'x-api-key: text'

No body

Update a webhook

patch

/public/communities/{subdomain}/webhooks/{webhookId}

Path parameters
webhookIdstring uuidrequired
subdomainstringrequired
Header parameters
x-api-keystringrequired
Body
namestring
activeboolean
uristring uri
eventsenum[]
Responses
curl -L \
  --request PATCH \
  --url 'https://api-v2.zealy.io/public/communities/{subdomain}/webhooks/{webhookId}' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"events":["JOINED_COMMUNITY"]}'

No body

List available event types a webhook can subscribe to

get

/public/communities/{subdomain}/webhooks-event-types

Path parameters
subdomainstringrequired
Header parameters
x-api-keystringrequired
Responses
curl -L \
  --url 'https://api-v2.zealy.io/public/communities/{subdomain}/webhooks-event-types' \
  --header 'x-api-key: text'
[
  "JOINED_COMMUNITY"
]

List events a webhook is subscribed to

get

/public/communities/{subdomain}/webhooks/{webhookId}/events

Path parameters
subdomainstringrequired
webhookIdstring uuidrequired
Query parameters
limitnumber
pagenullable number
statusFilterenum[]required
Header parameters
x-api-keystringrequired
Responses
curl -L \
  --url 'https://api-v2.zealy.io/public/communities/{subdomain}/webhooks/{webhookId}/events?statusFilter=success' \
  --header 'x-api-key: text'
{
  "page": 1,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "webhookId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-02-19T03:09:42.355Z",
      "updatedAt": "2025-02-19T03:09:42.355Z",
      "retryAt": "2025-02-19T03:09:42.355Z",
      "eventType": "text",
      "tries": 1,
      "status": "success"
    }
  ]
}

Last updated

Was this helpful?