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

Path parameters

subdomainstringRequired

Header parameters

x-api-keystringRequired

Responses

get

HTTPcURLJavaScriptPython

GET /public/communities/{subdomain}/webhooks HTTP/1.1
Host: api-v2.zealy.io
x-api-key: text
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "uri": "https://example.com",
      "communityId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-04-26T11:06:58.275Z",
      "updatedAt": "2025-04-26T11:06:58.275Z",
      "active": true,
      "secret": "text",
      "events": [
        "JOINED_COMMUNITY"
      ],
      "success": 1,
      "failed": 1,
      "exhausted": 1
    }
  ]
}

Create a new webhook

post

Path parameters

subdomainstringRequired

Header parameters

x-api-keystringRequired

Body

namestring · min: 1Required

uristring · uriRequired

activebooleanRequired

Responses

post

HTTPcURLJavaScriptPython

POST /public/communities/{subdomain}/webhooks HTTP/1.1
Host: api-v2.zealy.io
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "name": "text",
  "uri": "https://example.com",
  "active": true,
  "events": [
    "JOINED_COMMUNITY"
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Delete a webhook

delete

Path parameters

webhookIdstring · uuidRequired

subdomainstringRequired

Header parameters

x-api-keystringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /public/communities/{subdomain}/webhooks/{webhookId} HTTP/1.1
Host: api-v2.zealy.io
x-api-key: text
Accept: */*

No content

Update a webhook

patch

Path parameters

webhookIdstring · uuidRequired

subdomainstringRequired

Header parameters

x-api-keystringRequired

Body

namestring · min: 1Optional

activebooleanOptional

uristring · uriOptional

Responses

patch

HTTPcURLJavaScriptPython

PATCH /public/communities/{subdomain}/webhooks/{webhookId} HTTP/1.1
Host: api-v2.zealy.io
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "name": "text",
  "active": true,
  "uri": "https://example.com",
  "events": [
    "JOINED_COMMUNITY"
  ]
}

No content

List available event types a webhook can subscribe to

get

Path parameters

subdomainstringRequired

Header parameters

x-api-keystringRequired

Responses

get

HTTPcURLJavaScriptPython

GET /public/communities/{subdomain}/webhooks-event-types HTTP/1.1
Host: api-v2.zealy.io
x-api-key: text
Accept: */*

[
  "JOINED_COMMUNITY"
]

List events a webhook is subscribed to

get

Path parameters

subdomainstringRequired

webhookIdstring · uuidRequired

Query parameters

limitnumber · min: 1 · max: 100OptionalDefault: 100

pagenumber | nullableOptionalDefault: 0

Header parameters

x-api-keystringRequired

Responses

get

HTTPcURLJavaScriptPython

GET /public/communities/{subdomain}/webhooks/{webhookId}/events HTTP/1.1
Host: api-v2.zealy.io
x-api-key: text
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "webhookId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "success",
      "createdAt": "2025-04-26T11:06:58.275Z",
      "updatedAt": "2025-04-26T11:06:58.275Z",
      "retryAt": "2025-04-26T11:06:58.275Z",
      "eventType": "text",
      "tries": 1
    }
  ],
  "page": 1
}