v10

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

Integrations

Create Webhook Destination

This endpoint creates a new webhook destination. A webhook destination is a URL where webhook payloads will be sent.

post/organizations/{orgId}/integrationdestinations/webhooks

orgIdstring required

The unique identifier (UUID) for the organization. This specifies the organization within which the webhook destination is created.

urlstring required

The URL to which the webhook requests will be sent.

versioninteger

The version number of the entity:

Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.

namestring required

descriptionstring required

codestring

activeboolean

{
  "credentials": {
    "name": "Integration Credentials",
    "apiKey": "api key",
    "secret": "api secret"
  }
}

Returns the DestinationCreateRequest

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

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