Webhooks are a way to subscribe to events that happen in Moneybird. When an event occurs, Moneybird will send a POST request to the URL you provided. This way, you can keep your own system in sync with Moneybird.
For example, you can subscribe to the contact_created event to receive a notification when
a new contact is created in Moneybird.
Delete a webhook
Remove a registered webhook.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Webhook deleted
List all webhooks
List all registered webhooks for the administration.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A list of webhooks
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
urlstringenabled_eventsstring[]last_http_statusinteger | string | nullHTTP status code of the request last received back from the webhook
last_http_bodystring | nullBody of the request last received back from the webhook
tokenstring
Create a webhook
Creates a new webhook. The provided URL should respond with a 200 HTTP status. After creation, the URL will receive notifications when events on documents in the administration occur. It is also possible to subscribe to certain events by adding an array with events you would like to receive notifications from.
We strongly recommend that you use a secure HTTPS endpoint for receiving payload from Moneybird.
If you use unencrypted HTTP, anyone on the network may be able to listen in on sensitive information like contacts and invoices.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Webhook created
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
urlstringenabled_eventsstring[]last_http_statusinteger | string | nullHTTP status code of the request last received back from the webhook
last_http_bodystring | nullBody of the request last received back from the webhook
tokenstring