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

Request

  • Base URL
    https://app.officernd.com
  • URL
    https://app.officernd.com/api/v2/organizations/{orgSlug}/webhooks
  • Auth
    OAuth 2
    Authorization code: https://identity.officernd.com/auth/authorize
    Client credentials
    Token URL: https://identity.officernd.com/auth/token scopes: flex.settings.webhooks.read

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": "6ae88421c1df3a98369079b5",
      "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
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.