v1

latestOpenAPI 3.0.32026-08-0613775357.6 KB
webhooks

Show single webhook

Retrieves a single webhook by its ID.

get/webhooks/{webhook_id}

Path parameters

webhook_idinteger required

The ID of the webhook.

Response

The requested webhook object.

idinteger required

Unique identifier for the webhook.

urlstring uri required

URL associated with the webhook, to which events are posted.

status'active' required

The status of the webhook. Currently, the only valid status for a webhook is active.

event_type'project.created' | 'project.updated' | 'time.entry.created' | 'time.entry.updated' | 'user.created' | 'user.updated' | 'assignment.created' | 'assignment.updated' required

The type of event associated with the webhook.

organization_idinteger

Unique identifier for the organization.

created_atstring date-time

The time the webhook was created.

updated_atstring date-time

The time the webhook was last updated.

Example response

{
  "id": 123456,
  "url": "https://hooks.example.com/process_webhooks",
  "status": "active",
  "event_type": "project.created",
  "organization_id": 1
}