Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Webhooks

Add a new webhook

Add a new webhook

Required scopes: flex.settings.webhooks.create

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

Path parameters

orgSlugstring required

organization slug

Request body

eventTypesstring[] required

An array containg the type of events associated with the webhook.

urlstring required

The URL of the endpoint of your server where POST requests will be made.

descriptionstring

A description of the webhook.

isEnabledboolean

Determines whether the webhook is enabled. If left empty the webhook will be turned on by default.

Example request

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

Response

_idstring

The _id of the webhook.

urlstring

The URL of the endpoint of your server where POST requests will be made.

descriptionstring

A description of the webhook.

eventTypesstring[]

An array containg the type of events associated with the webhook.

secretstring

The secret key used to sign the webhook payload.

isEnabledboolean

Determines whether the webhook is enabled. If left empty the webhook will be turned on by default.

Example response

{
  "_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
}