Skip to main content
POST
Create webhook event

Authorizations

Authorization
string
header
required

Authenticate with an API access token in the Authorization header: Authorization: Bearer <token>. Create a token from the API Access Tokens page in Contractors Cloud, under Integrations.

Path Parameters

webhookId
string<uuid>
required

The id of the webhook.

Body

application/json
event
string
required

The event name to subscribe to. Must be one of the names returned by List subscribable events.

Example:

"projects.created"

Response

The created webhook event.

id
string<uuid>

The webhook event's unique identifier.

Example:

"b7e4a1c9-3d6f-4b2a-9c8e-5f1d3a7b9c40"

webhook_id
string<uuid>

The id of the webhook this subscription belongs to.

Example:

"a3d8f2e6-1c4b-4a9d-8e3f-2b5a7c9d4f60"

event
string

The subscribed event name. See List subscribable events for the current catalog.

Example:

"projects.created"

created_at
string | null

Timestamp when the subscription was created, formatted as YYYY-MM-DD HH:MM:SS. Null if not recorded.

Example:

"2025-02-11 09:05:00"

updated_at
string | null

Timestamp when the subscription was last updated, formatted as YYYY-MM-DD HH:MM:SS. Null if not recorded.

Example:

"2025-02-11 09:05:00"