Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
Integrations

Activate Webhook Destination

Set the active status on a webhook integration destination.

Use this endpoint to activate or deactivate a webhook integration destination. It toggles the active status of the specific wehbook destination with the given ID.

put/organizations/{orgId}/integrationdestinations/webhooks/{id}/active

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

idstring required

The unique identifier (UUID) of the webhook destination. This ID is used to specify which webhook integration is being targeted for activation or deactivation.

Query parameters

activeboolean

active status of the webhook

Response

Returns the WebhookDestinationRequest

urlstring

The URL to which webhook requests are sent.

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
dtCreatedstring date-time

The DateTime when this item was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when this item was last modified (in ISO-8601 format).

createdBystring

The ID of the user who created this item.

lastModifiedBystring

The ID of the user who last modified this item.

namestring
descriptionstring
codestring
activeboolean

Example response

{
  "credentials": {
    "apiKey": "api key",
    "secret": "api secret"
  }
}