Moneybird logo
Moneybird API

Webhooks

Endpoint:https://moneybird.com/api/v2

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

DELETE
https://moneybird.com/api/v2
/{administration_id}/webhooks/{id}{format}

Remove a registered webhook.

Delete a webhook › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Delete a webhook › Responses

Webhook deleted

No data returned

List all webhooks

GET
https://moneybird.com/api/v2
/{administration_id}/webhooks{format}

List all registered webhooks for the administration.

List all webhooks › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

List all webhooks › 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

  • urlstring
  • enabled_eventsstring[]
  • last_http_statusinteger | string | null

    HTTP status code of the request last received back from the webhook

  • last_http_bodystring | null

    Body of the request last received back from the webhook

  • tokenstring

Create a webhook

POST
https://moneybird.com/api/v2
/{administration_id}/webhooks{format}

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.

Create a webhook › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Create a webhook › Request Body

  • urlstring · required
  • enabled_events(string)[]

Create a webhook › Responses

Webhook created

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • urlstring
  • enabled_eventsstring[]
  • last_http_statusinteger | string | null

    HTTP status code of the request last received back from the webhook

  • last_http_bodystring | null

    Body of the request last received back from the webhook

  • tokenstring
VerificationsWorkflows