Webhooks

Overview

Webhooks allow partners to subscribe to real-time notifications of specific events occurring within the Monite system.

Monite sends these events via HTTPS as a JSON payload to an endpoint set by you. You can then use these notifications to execute actions in your backend systems.

Note: This video was recorded for an earlier version of the API, so there are minor differences in the request and response structure compared to the current API.

How to subscribe to webhooks

To start receiving webhooks, follow these steps:

1. Identify the events you want to monitor.
2. Create the webhook listener endpoint on your server.
3. Subscribe to the desired events by calling POST /webhook_subscriptions.
4. Handle the requests from Monite.

1. Identify the events you want to monitor

Currently, Monite triggers notifications for the following objects and events:

2. Create a webhook listener endpoint on your server

To receive webhooks requests from Monite, you must set up an HTTPS endpoint on your server. You can use one endpoint to handle several different event types at once or set up individual endpoints for specific events.

Your webhook listener endpoint must be accessible from the public Internet, accept POST requests, and expect a JSON request body with the following structure. The endpoint must also response with a 2XX status code.

1
{
2
  "id": "90cc1b23-9681-40f4-a54b-4c059cd4397d",
3
  "created_at": "2024-03-04T20:08:48.399442+00:00",
4
  "action": "entity.onboarding_requirements.updated",
5
  "api_version": "2024-01-31",
6
  "entity_id": "ce0e9fc7-b3e7-4f12-ad86-bfb0725a99f0",
7
  "description": "entity_onboarding_requirements_updated",
8
  "object": {
9
    "id": "ce0e9fc7-b3e7-4f12-ad86-bfb0725a99f0"
10
  },
11
  "object_type": "entity",
12
  "webhook_subscription_id": "c7f37127-44e5-494a-833a-21e60585f187"
13
}

The possible values for action are listed in the table above.

3. Subscribe to webhooks

To subscribe to the desired Monite webhook events, call POST /webhook_subscriptions with the request body containing your webhook listener url and the events you want to be notified about. If you omit event_types, Monite will notify you about all events of the specified object_type.

1
curl -X POST 'https://api.sandbox.monite.com/v1/webhook_subscriptions' \
2
     -H 'X-Monite-Version: 2024-01-31' \
3
     -H 'Authorization: Bearer YOUR_PARTNER_TOKEN' \
4
     -H 'Content-Type: application/json' \
5
     -d '{
6
       "url": "https://example.com/your-webhook-listener",
7
       "object_type": "entity",
8
       "event_types": [
9
         "created",
10
         "updated"
11
       ]
12
     }'

The successful response contains the id assigned to this webhook subscription and the secret that you can use to verify webhook signatures:

1
{
2
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3
  ...
4
  "secret": "whsec_Iw3mr...",
5
  "status": "enabled",
6
  "url": "https://example.com/your-webhook-listener"
7
}

4. Handle the requests from Monite

To handle the events sent by Monite, parse the body of the requests that arrive at your webhook endpoint. You can use the entity_id, object_type, and object_id to identify the affected entity and the object that was changed.

For example, the following webhook event means that an entity with ID 3fa85f64-5717-4562-b3fc-2c963f66afa6 created a new counterpart and that counterpart was assigned ID f0535ce9-8cdd-4f5c-bfe2-6a7f1429fbbe:

1
{
2
  "id": "06c003f1-6b05-415f-be6d-39ecacdddbd3",
3
  "created_at": "2024-03-04T20:06:48.593225+00:00",
4
  "action": "counterpart.created",
5
  "api_version": "2024-01-31",
6
  "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
7
  "description": "counterpart has been created",
8
  "object": {
9
    "id": "f0535ce9-8cdd-4f5c-bfe2-6a7f1429fbbe"
10
  },
11
  "object_type": "counterpart",
12
  "webhook_subscription_id": "c7f37127-44e5-494a-833a-21e60585f187"
13
}

To get the full details of the created counterpart, you can then call GET /counterparts/f0535ce9-8cdd-4f5c-bfe2-6a7f1429fbbe.

Retry policy

If your webhook listener endpoint returns an HTTP status code other than 2xx, Monite automatically retries to send the webhook for a total of a week. The time interval between the retries follows this schedule:

• 2 minutes
• 5 minutes
• 10 minutes
• 15 minutes
• 30 minutes
• 1 hour
• 2 hours
• 4 hours
• 8 hours
• After that, the webhook will be retried every 8 hours

If the unavailability persists for a total of a week, Monite automatically disables the corresponding webhook subscription and all further requests are canceled, including for new events. Additionally, Monite sends an email notification to the partner’s email address informing them of the disabled webhook subscription and providing details for further action. After resolving the issues with the webhook listener endpoint, the partner can manually re-enable the affected webhook subscription.

Partners can use GET /events to get the missed webhook events from the period when their webhook listener was unavailable:

GET /events?created_at__gte=<timestamp1>&created_at__lte=<timestamp2>

Review webhook deliveries

Monite keeps a log of delivery attempts for all webhook events that partners are subscribed to. A partner can call GET /webhook_deliveries to access the webhook delivery log for the events of a specific entity:

1
curl -X GET 'https://api.sandbox.monite.com/v1/webhook_deliveries' \
2
     -H 'X-Monite-Version: 2024-01-31' \
3
     -H 'X-Monite-Entity-Id: ENTITY_ID' \
4
     -H 'Authorization: Bearer YOUR_PARTNER_TOKEN'

The response contains information about how many times an event was triggered, the event ID, the status code of the last attempt, and whether or not the final attempt was successful.

Available data is limited to the last three months.

List all webhook subscriptions

To get a list of your existing webhook subscriptions, call GET /webhook_subscriptions. You can optionally filter the list by the webhook event type and the subscription date. For example:

• Get all subscriptions for entity events:

  GET /webhook_subscriptions?object_type=entity

• Get all subscriptions created on or after September 1, 2024:

  GET /webhook_subscriptions?created_at__gte=2024-09-01T00:00:00Z

Retrieve a webhook subscription

To get the details of a specific webhook subscription, call GET /webhook_subscriptions/{webhook_subscription_id}.

Update a webhook subscription

To update an existing webhook subscription, call PATCH /webhook_subscriptions/{webhook_subscription_id}. You can update the webhook listener URL and the list of events to get notifications for.

Disable a webhook subscription

All webhook subscriptions are enabled by default but get automatically disabled if Monite cannot connect to the webhook listener URL after a series of retries. You can also disable a webhook subscription manually by calling POST /webhook_subscriptions/{webhook_subcription_id}/disable:

1
curl -X POST 'https://api.sandbox.monite.com/v1/webhook_subscriptions/c7f37...187/disable' \
2
     -H 'X-Monite-Version: 2024-01-31' \
3
     -H 'Authorization: Bearer YOUR_PARTNER_TOKEN'

While a webhook subsription is disabled, the associated events are not triggered and therefore are not included in historical webhook data available via GET /events and GET /webhook_deliveries.

Enable a webhook subscription

To re-enable a disabled webhook subscription, call POST /webhook_subscriptions/{webhook_subscription_id}/enable:

1
curl -X POST 'https://api.sandbox.monite.com/v1/webhook_subscriptions/c7f37...187/enable' \
2
     -H 'X-Monite-Version: 2024-01-31' \
3
     -H 'Authorization: Bearer YOUR_PARTNER_TOKEN'

Delete a webhook subscription

To delete a webhook subscription, call DELETE /webhook_subscriptions/{webhook_subscription_id}. You will stop receiving webhooks for the events listed in that subscription.