v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Webhooks

Get a list of webhooks

Retrieve a list of webhooks based on provided filters

Required scopes: flex.settings.webhooks.read

get/api/v2/organizations/{orgSlug}/webhooks

Path parameters

orgSlugstring required

organization slug

Query parameters

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "_id": "6a59d080856fad4ee41952f9",
      "url": "https://webhook.site/1b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b",
      "description": "A webhook for testing purposes.",
      "eventTypes": [
        "membership.created",
        "membership.updated"
      ],
      "secret": "1b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b",
      "isEnabled": true
    }
  ]
}