HThtmlcsstoimage
Webhooks

Create a webhook

Changed on

Creates a webhook that receives the selected organization events. Subscribing to an event requires read access to its resource, for example templates:read for template events. A signing secret is generated for every webhook and returned as signing_secret in this response, even when signing is disabled. Store it securely to verify signed deliveries; updates, reads, lists, and MCP responses never return it. Creating an enabled webhook queues a webhook_test delivery, identified by test_event_id in the response. Secret parameter values are never returned.

Rate limit: 20 requests per minute per organization, shared across all operations in the webhook:write group and all API keys belonging to that organization.

post/v1/webhooks

Request

  • Base URL
    https://hcti.io
  • URL
    https://hcti.io/v1/webhooks
  • Auth
    HTTP basic

Request body

namestring required

Display name for the webhook, up to 255 characters. Leading and trailing whitespace is removed.

urlstring required

HTTPS endpoint that receives deliveries, up to 2048 characters, for example https://hooks.example.com/hcti. https:// is assumed when no scheme is given. Must use a DNS host name on the default HTTPS port, without credentials, a query string, or a fragment. Add query parameters through parameters.

disabledboolean

Whether the webhook is disabled. Disabled webhooks receive no deliveries, and queued deliveries are not sent. Defaults to false.

eventsWebhookEventType[] required

Complete list of event types to deliver. Subscribing to an event requires read access to its resource, for example templates:read for template events. webhook_test cannot be subscribed to. An empty array delivers only test events.

signing_enabledboolean

Whether to sign deliveries with this webhook's signing secret. The secret is generated when the webhook is created, returned only in the REST API create response, and can also be copied from the dashboard. Defaults to false.

Response

OK

idstring required

Webhook ID.

namestring required

Display name for the webhook.

enabledboolean

Whether the webhook is enabled. Disabled webhooks receive no deliveries.

urlstring required

HTTPS endpoint that receives deliveries, without query parameters.

eventsWebhookEventType[] required

Event types delivered to this webhook.

signing_enabledboolean

Whether deliveries are signed with this webhook's signing secret.

signing_secretstring nullable

Signing secret for verifying deliveries. Returned only in the REST API create response, even when signing is disabled. Store it securely; updates, reads, lists, and MCP responses omit this field.

created_atstring date-time

UTC timestamp when the webhook was created.

updated_atstring date-time

UTC timestamp when the webhook was last updated.

test_event_idstring nullable

Event ID of the webhook_test delivery this create or update queued, matching the event_id the endpoint receives. Null when no test was queued, and always null outside create and update responses.

Changes