OFofficernd
Webhooks

Update an existing webhook

Update an existing webhook

Required scopes: flex.settings.webhooks.update

put/api/v2/organizations/{orgSlug}/webhooks/{webhookId}

Request

  • Base URL
    https://app.officernd.com
  • URL
    https://app.officernd.com/api/v2/organizations/{orgSlug}/webhooks/{webhookId}
  • 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.update

Path parameters

webhookIdstring required

webhook id

orgSlugstring required

organization slug

Request body

isEnabledboolean

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

Example request

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