HUhubstaff
webhooks

Activate webhook

Activates a webhook after endpoint verification.

You must include the X-Hook-Secret header with the secret value you received during the verification step.

Once activated, the webhook will start receiving events.

post/v2/webhooks/{webhook_id}/activate

Request

Path parameters

webhook_idstring required

Webhook ID

Response

The activated webhook

idstring required

Webhook ID (UUID)

eventsstring[] required

Subscribed event types, ["*"] for all

target_urlstring required

The URL that receives webhook POST requests

status'inactive' | 'pending' | 'active' | 'disabled' required

inactive: verification request not sent yet. pending: the endpoint did not echo X-Hook-Secret; call activate with the secret. active: events are delivered. disabled: verification or delivery failed; delete and recreate the webhook.

created_atstring required

Creation time in UTC, ISO 8601 without an offset

updated_atstring required

Last update time in UTC, ISO 8601 without an offset

Changes

No recorded changes to this operation across all 1 revision of this API.