OFofficernd
Webhooks

Add a new webhook

Add a new webhook

Required scopes: flex.settings.webhooks.create

post/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.create

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": "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.