HThtmlcsstoimage
Webhooks

Get a webhook event

Changed on

Returns one event's payload and each destination's delivery status and attempts. data is null, and payload_withheld is true, when the key can't read the event's resource, for example templates:read for template events.

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

get/v1/webhooks/events/{id}

Request

  • Base URL
    https://hcti.io
  • URL
    https://hcti.io/v1/webhooks/events/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

Response

OK

payload_withheldboolean

True when your key can't read this event type's resources, so data is left out. Its destinations are still listed.

event_idstring required

Unique ID of this event. It is the same for every webhook that receives the event, and on every retry.

type'webhook_test' | 'template_created' | 'template_updated' | 'template_deleted' | 'image_deleted' | 'image_stored' | 'proxy_created' | 'proxy_updated' | 'proxy_deleted' | 'storage_destination_created' | 'storage_destination_updated' | 'storage_destination_deleted' | 'og_config_created' | 'og_config_updated' | 'og_config_deleted' | 'api_key_created' | 'api_key_updated' | 'api_key_deleted' | 'organization_plan_changed' | 'organization_usage_reset' | 'organization_usage_alert' required

An event type a webhook can receive. webhook_test deliveries are sent automatically and cannot be subscribed to.

occurred_atstring date-time required

UTC time the event happened.

Changes