Webhooks

/webhooks/{webhook_id}

Update a webhook's configuration. Only the fields you provide are changed.

Setting active: true on an auto-disabled webhook re-enables it and resets the consecutive-failure counter — fix the underlying issue first or it will be auto-disabled again.

The signing secret cannot be rotated through this endpoint; delete and re-create the webhook if you need a new secret.

put/v1/webhooks/{webhook_id}

Request

  • Base URL: https://api.companydata.dk (the document declares no server; this is the origin it was published from)
  • URL: https://api.companydata.dk/v1/webhooks/{webhook_id}
  • Auth: HTTP bearer

Path parameters

webhook_idstring required

Request body

namestring nullable

New label for the webhook.

urlstring nullable

New HTTPS endpoint URL.

event_typesEventType[] nullable

Replace the list of event types this webhook receives.

headersobject nullable

Replace the custom headers sent with every delivery.

activeboolean nullable

Enable or disable delivery. Setting true on an auto-disabled webhook re-enables it and resets the consecutive-failure counter.

Response

Successful Response

webhook_idstring required

Unique identifier for this webhook.

namestring required

Human-readable label.

urlstring required

HTTPS endpoint that receives deliveries.

activeboolean required

Whether this webhook is currently delivering events.

event_typesEventType[] required

Event types this webhook receives.

headersobject required

Custom headers added to every delivery.

last_success_atstring date-time nullable

Timestamp of the most recent successful (2xx) delivery.

last_failure_atstring date-time nullable

Timestamp of the most recent failed delivery attempt.

consecutive_failuresinteger

Number of consecutive failed deliveries. Reset to 0 on the next 2xx response. Reaching 10 auto-disables the webhook.

disabled_reasonstring nullable

Set when the webhook is auto-disabled. null otherwise.

created_atstring date-time required

When the webhook was created.

Changes

No recorded changes to this operation across all 2 revisions of this API.