Update Webhook Endpoint Options

This endpoint changes the options of one webhook endpoint of the company: its signature mode and
whether it skips empty booking.updated events. Only the options sent change. The URL, the events
and the secret are changed from the AgendaPro web app; other fields in the body are ignored.

Important Notes

  • Requires webhooks:write scope.

  • signature_mode: legacy, dual or standard (see Webhooks › Signature). The legacy
    signature is deprecated, so we recommend migrating: move an endpoint in legacy to dual
    once your receiver verifies the standard signature, then to standard.

  • The signature mode moves one step at a time, so every change keeps a signature your receiver
    already verifies:

    FromTo legacyTo dualTo standard
    legacyno changeallowed422 restricted/signature_mode
    dualallowed (rollback)no changeallowed
    standard422 restricted/signature_modeallowed (rollback)no change

    Sending the current mode changes nothing. skip_empty_updates can be changed alone, in any
    mode. When the request is rejected, nothing in it is applied.

  • skip_empty_updates: true stops the booking.updated events whose changes is empty or
    holds only updated_at (see Webhooks › When an *.updated event is sent). Off by default.

  • The change applies to the deliveries signed after it; a retry of an earlier message is signed
    again with the current mode.

  • An endpoint of another company, a deleted one or an unknown id answers 404.

Errors Dictionary

StatusErrorDetailDescription
400invalid_formatsignature_modesignature_mode is not legacy, dual or standard.
400invalid_formatskip_empty_updatesskip_empty_updates is not a JSON boolean.
400invalid_bodyexpected_objectThe body is not a JSON object.
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks webhooks:write scope.
404not_foundwebhook_endpointThe endpoint does not exist, was deleted or belongs to another company.
422restrictedsignature_modeThe change skips a step: legacy → standard or standard → legacy (go through dual).
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Webhook endpoint identifier.

Body Params

The options of a webhook endpoint; only the ones sent change.

string
enum

Which signatures webhook-signature carries: legacy only the legacy one (deprecated; the mode
of the endpoints that existed when the options were introduced), dual the standard one
first and the legacy one after it (the mode of new endpoints), standard only the standard one.

Allowed:
boolean

True stops the booking.updated events whose changes is empty or only updated_at.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json