Change a webhook (URL, events, filters, on/off)
Only send the fields to change. enabled: false pauses the webhook: events are held while it is paused. enabled: true resumes it (and resets an automatically disabled webhook); held events under 72 hours old are then sent in order, older ones are marked as expired. The response then has held_released and held_expired.
Authentication
Your API key as a Bearer token.
Parameters
The webhook's id.
Body
application/jsonurlstring<uri>HTTPS URL we send POST requests to.
eventsenum<string>[]Event types, e.g. address.updated, or * for all.
enabledbooleanfalse = pause, true = resume.
filtersobjectOptional resource filters. Within a field it is "or", between fields "and"; an empty object = all events. Account events (invoice.*, quota.*, subscription.*, job.*) are never filtered. An event where e.g. the municipality cannot be determined is not sent when filtering on municipality. At most 5000 values in total.
Show child attributes(4)
filters.bfe_numreinteger[]BFE numbers (properties).
filters.postnumrestring[]Postcodes (4 digits), e.g. 2100.
filters.adresse_idsstring<uuid>[]Address or access address ids (UUID).
filters.kommunekoderstring[]Municipality codes (4 digits), e.g. 0101.
Request
Response
The updated webhook
idstring<uuid>urlstring<uri>eventsstring[]secretstringThe signing secret — only in the response to the creation.
statusenum<string>activepausedauto_disabledenabledbooleanfiltersobjectOptional resource filters. Within a field it is "or", between fields "and"; an empty object = all events. Account events (invoice.*, quota.*, subscription.*, job.*) are never filtered. An event where e.g. the municipality cannot be determined is not sent when filtering on municipality. At most 5000 values in total.
Show child attributes(4)
filters.bfe_numreinteger[]BFE numbers (properties).
filters.postnumrestring[]Postcodes (4 digits), e.g. 2100.
filters.adresse_idsstring<uuid>[]Address or access address ids (UUID).
filters.kommunekoderstring[]Municipality codes (4 digits), e.g. 0101.
created_atstring<date-time>auto_disabled_atstring<date-time> | nullconsecutive_failuresinteger