Webhook Event Configurations

The Webhook Event Configurations API allows super users to configure which events should be delivered through each Webhook.

NOTE: This API requires the following feature flag to be enabled: Webhooks.

List Webhook Event Configurations

This endpoint retrieves a list of Webhook Event Configuration resources for a specific Webhook.

NOTE: This endpoint requires the following feature flag to be enabled: Webhooks.

GET /api/v2/webhooks/{webhook_id}/configs/

Path Parameter	Description
webhook_id	Integer ID of the parent Webhook.

GET /api/v2/webhooks/1/configs/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
    "results": [{
        "id": 10,
        "webhook": 1,
        "event_source": "CreatedProjectActivity",
        "active": true,
        "created": "2025-03-31T10:30:00.000Z",
        "updated": "2025-03-31T10:30:00.000Z"
    }]
}

Retrieve a Webhook Event Configuration

Retrieve a single Webhook Event Configuration resource by its ID for a specific Webhook.

NOTE: This endpoint requires the following feature flag to be enabled: Webhooks.

GET /api/v2/webhooks/{webhook_id}/configs/{id}/

Path Parameter	Description
webhook_id	Integer ID of the parent Webhook.
id	Integer ID of the Webhook Event Configuration.

GET /api/v2/webhooks/1/configs/10/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 10,
    "webhook": 1,
    "event_source": "CreatedProjectActivity",
    "active": true,
    "created": "2025-03-31T10:30:00.000Z",
    "updated": "2025-03-31T10:30:00.000Z"
}

Create a Webhook Event Configuration

Create a new Webhook Event Configuration under a specific Webhook.

NOTE: This endpoint requires the following feature flag to be enabled: Webhooks.

POST /api/v2/webhooks/{webhook_id}/configs/

Path Parameter	Description
webhook_id	Integer ID of the parent Webhook.

Fields	Required	Description
event_source	Yes	The event source to deliver through this webhook. For this epic, only `CreatedProjectActivity` is supported.
active	No	Whether this configuration is active. Defaults to `true`.

POST /api/v2/webhooks/1/configs/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "event_source": "CreatedProjectActivity",
    "active": true
}

HTTP/1.1 201 CREATED
Content-Type: application/json

{
    "id": 10,
    "webhook": 1,
    "event_source": "CreatedProjectActivity",
    "active": true,
    "created": "2025-03-31T10:30:00.000Z",
    "updated": "2025-03-31T10:30:00.000Z"
}

Update a Webhook Event Configuration

Update an existing Webhook Event Configuration using a partial update (PATCH). Full replacement via PUT is not supported.

NOTE: This endpoint requires the following feature flag to be enabled: Webhooks.

PATCH /api/v2/webhooks/{webhook_id}/configs/{id}/

Path Parameter	Description
webhook_id	Integer ID of the parent Webhook.
id	Integer ID of the Webhook Event Configuration.

Fields	Required	Description
event_source	No	The event source to deliver through this webhook. For this epic, only `CreatedProjectActivity` is supported. Omit this field if you are only changing `active`.
active	No	Whether this configuration is active.

PATCH /api/v2/webhooks/1/configs/10/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "active": false
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 10,
    "webhook": 1,
    "event_source": "CreatedProjectActivity",
    "active": false,
    "created": "2025-03-31T10:30:00.000Z",
    "updated": "2025-03-31T11:00:00.000Z"
}

Delete a Webhook Event Configuration

Delete an existing Webhook Event Configuration.

NOTE: This endpoint requires the following feature flag to be enabled: Webhooks.

DELETE /api/v2/webhooks/{webhook_id}/configs/{id}/

Path Parameter	Description
webhook_id	Integer ID of the parent Webhook.
id	Integer ID of the Webhook Event Configuration.

DELETE /api/v2/webhooks/1/configs/10/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 204 NO CONTENT

Webhook Event Configurations