Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
Event

Create a new Webhook

post/orgs/{orgId}/apps/{appId}/webhooks

Path parameters

orgIdstring required

The Organization ID.

appIdstring required

The Application ID.

Request body

disabledboolean nullable

Defines whether this job is currently disabled.

headersJSONFieldRequest
idstring

Job ID, unique within the Organization

payloadJSONFieldRequest
urlstring nullable

The webhook's URL (without protocol, only HTTPS is supported).

Response

A created webhook.

created_atstring

The timestamp of when this Job was created.

created_bystring

The user who created this Job

disabledboolean nullable required

Defines whether this job is currently disabled.

headersJSONFieldResponse required
idstring required

Job ID, unique within the Organization

payloadJSONFieldResponse required
urlstring nullable required

The webhook's URL (without protocol, only HTTPS is supported).

Example response

{
  "created_at": "2020-06-22T09:37:23.523Z"
}