Webhooks

Replace a webhook endpoint

Changed on

Replaces rather than patches: half a subscription is not a state worth reaching by accident.

Saving clears the failure tally and any automatic switch-off — you are saying something changed, so what the history counted no longer describes what is there. This is how an endpoint switched off by repeated failures is put back into service.

put/company/v3/webhooks/{id}

Request

  • Base URL: https://api.clockster.com
  • URL: https://api.clockster.com/company/v3/webhooks/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

The id of the row, as this API issued it.

Request body

titlestring nullable

What to call this endpoint, so a list of them reads.

urlstring required

Where deliveries are posted. http or https.

contact_emailstring email nullable

An address to reach you about this endpoint.

eventsstring[] required

Which events this endpoint receives. At least one, and no repeats.

auth_tokenstring nullable

Send deliveries carrying this bearer token. Not alongside auth_basic.

activeboolean required

Whether the endpoint receives deliveries. False stops them without deleting it.

Response

Success

Changes