Sign in

v1

latestOpenAPI 3.0.32026-08-0613775357.6 KB
webhooks

Create webhook

Creates a webhook that you can use to receive notifications about key events. Currently, webhooks are supported for the following events:

Event typeDescription
project.createdFires when a new project is created
project.updatedFires when a project is updated
time.entry.createdFires when a new time entry is created
time.entry.updatedFires when a time entry is updated
user.createdFires when a new user is created
user.updatedFires when a user is updated
assignment.createdFires when a new assignment is created
assignment.updatedFires when an assignment is updated
post/webhooks

Request body

urlstring uri required

URL to which events should be posted. Must be an HTTPS URL with a valid host.

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.

Example request

{
  "url": "https://hooks.example.com/process_webhooks",
  "event_type": "project.created"
}

Response

The webhook was created successfully.

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
}