API reference

Webhooks

Endpoints on your side that Monotree calls when something changes, and the deliveries made to them.

Base URL https://partners.monotree.com/api/v1 · every call needs a token

List webhook endpoints

get /webhooks webhooks:manage

Your webhook endpoints of the token's mode (live or sandbox), newest first. Only the endpoints the token may touch are listed: those whose events it may all read, both the types an endpoint is subscribed to and the types among the deliveries it still holds. See Which endpoints a token sees.

Parameters

limit

integer · query

How many to return in a page, 1 to 100.

default 25 · up to 100

cursor

string · query

The next_cursor of the page before, for the next page. Send the same filters with it.
Response · 200 A page of endpoints.

object

string

has_more

boolean

Whether there is a page after this one.

next_cursor

string, nullable

Pass as cursor for the next page.

data

array of objects

Errors

400 invalid_cursor: the cursor is not one this API gave out.
401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
422 validation_error: a field is missing or invalid; fields says which.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl https://partners.monotree.com/api/v1/webhooks \
  -H "Authorization: Bearer $MONOTREE_TOKEN"
200 · Response
{
    "object": "list",
    "has_more": false,
    "next_cursor": "string",
    "data": [
        {
            "id": "whe_01jd1f4c8m2p0r6t9w3y5a7c1e",
            "object": "webhook_endpoint",
            "url": "https://api.acme.example/hooks/monotree",
            "description": "Back office, production",
            "events": [
                "customer.live",
                "customer.failed"
            ],
            "active": true,
            "paused_at": "2026-11-12T09:41:00Z",
            "paused_reason": "manual",
            "secret": "string",
            "previous_secret_expires_at": "2026-11-12T09:41:00Z",
            "failed_24h": 0,
            "last_delivery": {
                "id": "whd_01jd1g2h3j4k5m6n7p8q9r0s1t",
                "status": "delivered",
                "response_code": 200,
                "created_at": "2026-11-12T09:42:18Z"
            },
            "sandbox": false,
            "created_at": "2026-11-10T14:05:00Z"
        }
    ]
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Add a webhook endpoint

post /webhooks webhooks:manage

Adds an endpoint for the token's mode: one added with a sandbox token gets sandbox events only. The signing secret is in the answer to this call only; store it. The URL must be https and lead to a public address: one whose host resolves to a private, loopback, link-local or reserved address is refused, here and again on every delivery. At most 10 endpoints per mode. An endpoint is only sent events its maker may read: the token needs the ability that reads each type in events (customers:read for customer.*, seller.* and adoption.* events, support:read for support.*, webhooks:manage for webhook_endpoint.*), and all of them for *, which is also what leaving events out means. Otherwise the answer is 403 and names the ability that is missing.

Accepts an optional Idempotency-Key header to make a retry safe.

Request body

url required

string

An https URL that leads to a public address. http and local hosts are refused.

at most 255 characters

description

string, nullable

Your own note about the endpoint.

at most 120 characters

events

array of strings

* for every event, also ones added later, or the types you want from the Event types guide (customer.live, customer.failed, …). An unknown type is refused.

default ["*"]

active

boolean

false adds the endpoint paused.

default true

Response · 201 The endpoint, with its secret.

id

string

object

string

url

string

description

string, nullable

Your own note about the endpoint.

events

array of strings

The event types it gets; * for all.

active

boolean

False while the endpoint is paused: no events are sent to it.

paused_at

string, nullable

Since when it is paused; null while it is on.

paused_reason

string, nullable

manual: paused by you. failing: paused by Monotree after 5 days of nothing but failed deliveries, at least 20 of them.

one of manual, failing

secret

string

The signing secret (whsec_…). Only in the answers to Add a webhook endpoint and Rotate the signing secret.

previous_secret_expires_at

string, nullable

After a rotation, until when events are also signed with the secret before it. Null otherwise.

failed_24h

integer

Deliveries that gave up as failed in the last 24 hours.

last_delivery

object, nullable

The newest delivery to the endpoint.

id

string

status

string

one of pending, delivered, retrying, failed

response_code

integer, nullable

created_at

string

sandbox

boolean

created_at

string

Errors

400 invalid_idempotency_key: the Idempotency-Key is longer than 255 characters.
401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks webhooks:manage, or the ability that reads one of the events asked for (all of them for * or when events is left out). The message names it.
409 limit_reached: you already have 10 endpoints in this mode. endpoints_busy: another request is adding an endpoint right now; try again in a moment. idempotency_in_progress: a call with the same Idempotency-Key is still running. idempotency_key_taken: the key was used by another of your tokens.
422 validation_error: a field is missing or invalid; fields says which. idempotency_key_reused: the Idempotency-Key was used for a different request.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl -X POST https://partners.monotree.com/api/v1/webhooks \
  -H "Authorization: Bearer $MONOTREE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://api.acme.example/hooks/monotree",
    "description": "Back office, production",
    "events": [
        "customer.live",
        "customer.failed"
    ]
}'
201 · Response
{
    "id": "whe_01jd1f4c8m2p0r6t9w3y5a7c1e",
    "object": "webhook_endpoint",
    "url": "https://api.acme.example/hooks/monotree",
    "description": "Back office, production",
    "events": [
        "customer.live",
        "customer.failed"
    ],
    "active": true,
    "paused_at": "2026-11-12T09:41:00Z",
    "paused_reason": "manual",
    "secret": "string",
    "previous_secret_expires_at": "2026-11-12T09:41:00Z",
    "failed_24h": 0,
    "last_delivery": {
        "id": "whd_01jd1g2h3j4k5m6n7p8q9r0s1t",
        "status": "delivered",
        "response_code": 200,
        "created_at": "2026-11-12T09:42:18Z"
    },
    "sandbox": false,
    "created_at": "2026-11-10T14:05:00Z"
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Get a webhook endpoint

get /webhooks/{webhook} webhooks:manage

One endpoint with its health: failed_24h and last_delivery. The signing secret is not in this answer. A token only finds an endpoint whose events it may all read (the types it is subscribed to and the types among its deliveries); any other endpoint answers 404: see Which endpoints a token sees.

Parameters

webhook required

string · path

The webhook endpoint's ID (whe_…).
Response · 200 The endpoint.

id

string

object

string

url

string

description

string, nullable

Your own note about the endpoint.

events

array of strings

The event types it gets; * for all.

active

boolean

False while the endpoint is paused: no events are sent to it.

paused_at

string, nullable

Since when it is paused; null while it is on.

paused_reason

string, nullable

manual: paused by you. failing: paused by Monotree after 5 days of nothing but failed deliveries, at least 20 of them.

one of manual, failing

secret

string

The signing secret (whsec_…). Only in the answers to Add a webhook endpoint and Rotate the signing secret.

previous_secret_expires_at

string, nullable

After a rotation, until when events are also signed with the secret before it. Null otherwise.

failed_24h

integer

Deliveries that gave up as failed in the last 24 hours.

last_delivery

object, nullable

The newest delivery to the endpoint.

id

string

status

string

one of pending, delivered, retrying, failed

response_code

integer, nullable

created_at

string

sandbox

boolean

created_at

string

Errors

401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
404 not_found: no such webhook endpoint.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl https://partners.monotree.com/api/v1/webhooks/whe_01jd1f4c8m2p0r6t9w3y5a7c1e \
  -H "Authorization: Bearer $MONOTREE_TOKEN"
200 · Response
{
    "id": "whe_01jd1f4c8m2p0r6t9w3y5a7c1e",
    "object": "webhook_endpoint",
    "url": "https://api.acme.example/hooks/monotree",
    "description": "Back office, production",
    "events": [
        "customer.live",
        "customer.failed"
    ],
    "active": true,
    "paused_at": "2026-11-12T09:41:00Z",
    "paused_reason": "manual",
    "secret": "string",
    "previous_secret_expires_at": "2026-11-12T09:41:00Z",
    "failed_24h": 0,
    "last_delivery": {
        "id": "whd_01jd1g2h3j4k5m6n7p8q9r0s1t",
        "status": "delivered",
        "response_code": 200,
        "created_at": "2026-11-12T09:42:18Z"
    },
    "sandbox": false,
    "created_at": "2026-11-10T14:05:00Z"
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Change a webhook endpoint

patch /webhooks/{webhook} webhooks:manage

Change the URL or the events, or pause it with active: false. active: true switches a paused endpoint on again, also one Monotree paused because it only failed. New events need the abilities that read them, as when adding one: a token cannot widen an endpoint to events it may not read (403). A token only finds an endpoint whose events it may all read (the types it is subscribed to and the types among its deliveries); any other endpoint answers 404: see Which endpoints a token sees. So a token cannot point, pause or describe an endpoint for events it may not read either.

Parameters

webhook required

string · path

The webhook endpoint's ID (whe_…).

Request body

url

string

An https URL that leads to a public address. http and local hosts are refused.

at most 255 characters

description

string, nullable

Your own note about the endpoint.

at most 120 characters

events

array of strings

The whole list, replacing the one before.

active

boolean

false pauses the endpoint, true switches it on again.
Response · 200 The endpoint.

id

string

object

string

url

string

description

string, nullable

Your own note about the endpoint.

events

array of strings

The event types it gets; * for all.

active

boolean

False while the endpoint is paused: no events are sent to it.

paused_at

string, nullable

Since when it is paused; null while it is on.

paused_reason

string, nullable

manual: paused by you. failing: paused by Monotree after 5 days of nothing but failed deliveries, at least 20 of them.

one of manual, failing

secret

string

The signing secret (whsec_…). Only in the answers to Add a webhook endpoint and Rotate the signing secret.

previous_secret_expires_at

string, nullable

After a rotation, until when events are also signed with the secret before it. Null otherwise.

failed_24h

integer

Deliveries that gave up as failed in the last 24 hours.

last_delivery

object, nullable

The newest delivery to the endpoint.

id

string

status

string

one of pending, delivered, retrying, failed

response_code

integer, nullable

created_at

string

sandbox

boolean

created_at

string

Errors

401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks webhooks:manage, or url or events was sent and the token lacks the ability that reads one of the endpoint's events. The message names it.
404 not_found: no such webhook endpoint.
422 validation_error: a field is missing or invalid; fields says which.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl -X PATCH https://partners.monotree.com/api/v1/webhooks/whe_01jd1f4c8m2p0r6t9w3y5a7c1e \
  -H "Authorization: Bearer $MONOTREE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
        "customer.live",
        "customer.failed",
        "customer.cancelled"
    ]
}'
200 · Response
{
    "id": "whe_01jd1f4c8m2p0r6t9w3y5a7c1e",
    "object": "webhook_endpoint",
    "url": "https://api.acme.example/hooks/monotree",
    "description": "Back office, production",
    "events": [
        "customer.live",
        "customer.failed"
    ],
    "active": true,
    "paused_at": "2026-11-12T09:41:00Z",
    "paused_reason": "manual",
    "secret": "string",
    "previous_secret_expires_at": "2026-11-12T09:41:00Z",
    "failed_24h": 0,
    "last_delivery": {
        "id": "whd_01jd1g2h3j4k5m6n7p8q9r0s1t",
        "status": "delivered",
        "response_code": 200,
        "created_at": "2026-11-12T09:42:18Z"
    },
    "sandbox": false,
    "created_at": "2026-11-10T14:05:00Z"
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Delete a webhook endpoint

delete /webhooks/{webhook} webhooks:manage

Removes the endpoint and its delivery log. Events that happen from now on are no longer sent to it; they stay in List events. A token only finds an endpoint whose events it may all read (the types it is subscribed to and the types among its deliveries); any other endpoint answers 404: see Which endpoints a token sees.

Parameters

webhook required

string · path

The webhook endpoint's ID (whe_…).

Errors

401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
404 not_found: no such webhook endpoint.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl -X DELETE https://partners.monotree.com/api/v1/webhooks/whe_01jd1f4c8m2p0r6t9w3y5a7c1e \
  -H "Authorization: Bearer $MONOTREE_TOKEN"

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Send a test event

post /webhooks/{webhook}/test webhooks:manage

Sends a ping event to the endpoint at once and answers with the delivery: its status, your server's response_code and response_body. A failed test is not retried. At most 10 test events and redeliveries a minute to one endpoint. A token only finds an endpoint whose events it may all read (the types it is subscribed to and the types among its deliveries); any other endpoint answers 404: see Which endpoints a token sees.

Parameters

webhook required

string · path

The webhook endpoint's ID (whe_…).

Accepts an optional Idempotency-Key header to make a retry safe.

Response · 202 The delivery.

id

string

object

string

event_id

string

The id of the event that was sent.

event

string

The event type.

status

string

pending waiting for its first try · delivered your server answered 2xx · retrying a try failed and another is planned at next_attempt_at · failed given up after six tries.

one of pending, delivered, retrying, failed

attempts

integer

Tries made so far, of six at most (a test event is tried once). Sending the delivery again starts them over at 1; redeliveries says how often that happened.

redeliveries

integer

How many times the delivery was sent again by hand: with Redeliver a delivery, Redeliver failed deliveries or the button in the portal. 0 for a delivery that was never sent again.

response_code

integer, nullable

The status code of your server's last answer. Null when there was none (a timeout, no connection).

duration_ms

integer, nullable

next_attempt_at

string, nullable

delivered_at

string, nullable

created_at

string

payload

object

The event body sent, the same on every try. Only when one delivery is asked for, and only when the token may read events of this type.

id

string

The same on every delivery and redelivery of the event; also in the Monotree-Event-Id header. Keep it to skip repeats.

object

string

type

string

See the Event types guide.

api_version

string

The version of the API the event's data is written in; also in the Monotree-Api-Version header.

created_at

string

sandbox

boolean

actor

object, nullable

Who did it: a person in the portal (user), an API token (token, named API · <token name>) or Monotree itself (system). On support events also the assistant (assistant), and on support.message.received the person at the customer who wrote (customer).

type

string

one of user, token, system, assistant, customer

name

string

data

object

What the event is about, in the shapes the API returns. For a customer event: customer (the whole customer right after the event) and details. For a seller event: seller, always without two_factor, passkeys and last_login_at. The Event types guide says what each type carries.

response_body

string, nullable

The first 2,000 bytes of your server's last answer, or the error when there was none. Only when one delivery is asked for, and only when the token may read events of this type.

Errors

400 invalid_idempotency_key: the Idempotency-Key is longer than 255 characters.
401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
404 not_found: no such webhook endpoint.
409 idempotency_in_progress: a call with the same Idempotency-Key is still running.
422 idempotency_key_reused: the Idempotency-Key was used for a different request.
429 rate_limited: more than 10 test events and redeliveries to this endpoint in a minute, or over the general limit. Wait for the number of seconds in Retry-After.
curl -X POST https://partners.monotree.com/api/v1/webhooks/whe_01jd1f4c8m2p0r6t9w3y5a7c1e/test \
  -H "Authorization: Bearer $MONOTREE_TOKEN"
202 · Response
{
    "id": "whd_01jd1g2h3j4k5m6n7p8q9r0s1t",
    "object": "webhook_delivery",
    "event_id": "evt_01jcz8wg4h7v3y6n9q2k5m8p1r",
    "event": "customer.live",
    "status": "delivered",
    "attempts": 1,
    "redeliveries": 0,
    "response_code": 200,
    "duration_ms": 182,
    "next_attempt_at": null,
    "delivered_at": "2026-11-12T09:42:18Z",
    "created_at": "2026-11-12T09:42:18Z",
    "payload": {
        "id": "evt_01jcz8wg4h7v3y6n9q2k5m8p1r",
        "object": "event",
        "type": "customer.live",
        "api_version": "1.0.0",
        "created_at": "2026-11-12T09:42:18Z",
        "sandbox": false,
        "actor": {
            "type": "system",
            "name": "Monotree"
        },
        "data": {
            "customer": {
                "id": "cus_01jcz8w3k1x9q2v7s4e6m0b5n8",
                "object": "customer",
                "status": "live",
                "company_name": "Boulangerie Martin",
                "company_id": "boulangeriemartin",
                "external_ref": "org_48213"
            },
            "details": {
                "url": "https://boulangeriemartin.monotree.com",
                "admin_email": "claire@boulangeriemartin.example"
            }
        }
    },
    "response_body": "string"
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Rotate the signing secret

post /webhooks/{webhook}/rotate-secret webhooks:manage

Gives the endpoint a new signing secret, in the answer to this call only. The secret before it stays valid for expire_previous_in seconds: until then every event is signed with both (two v1 values in Monotree-Signature), so your server keeps accepting events while you move it to the new secret.

A token only finds an endpoint whose events it may all read; any other endpoint answers 404 (Which endpoints a token sees): a secret is not rotated by a token that may not read what the secret signs.

Parameters

webhook required

string · path

The webhook endpoint's ID (whe_…).

Accepts an optional Idempotency-Key header to make a retry safe.

Request body

expire_previous_in

integer

Seconds the previous secret stays valid: a day unless you say otherwise, a week at most, 0 to stop it at once.

from 0 · up to 604800 · default 86400

Response · 200 The endpoint, with its new secret.

id

string

object

string

url

string

description

string, nullable

Your own note about the endpoint.

events

array of strings

The event types it gets; * for all.

active

boolean

False while the endpoint is paused: no events are sent to it.

paused_at

string, nullable

Since when it is paused; null while it is on.

paused_reason

string, nullable

manual: paused by you. failing: paused by Monotree after 5 days of nothing but failed deliveries, at least 20 of them.

one of manual, failing

secret

string

The signing secret (whsec_…). Only in the answers to Add a webhook endpoint and Rotate the signing secret.

previous_secret_expires_at

string, nullable

After a rotation, until when events are also signed with the secret before it. Null otherwise.

failed_24h

integer

Deliveries that gave up as failed in the last 24 hours.

last_delivery

object, nullable

The newest delivery to the endpoint.

id

string

status

string

one of pending, delivered, retrying, failed

response_code

integer, nullable

created_at

string

sandbox

boolean

created_at

string

Errors

400 invalid_idempotency_key: the Idempotency-Key is longer than 255 characters.
401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
404 not_found: no such webhook endpoint.
409 idempotency_in_progress: a call with the same Idempotency-Key is still running.
422 validation_error: a field is missing or invalid; fields says which. idempotency_key_reused: the Idempotency-Key was used for a different request.
429 rate_limited: more than 10 rotations in an hour for this endpoint, or over the general limit. Wait for the number of seconds in Retry-After.
curl -X POST https://partners.monotree.com/api/v1/webhooks/whe_01jd1f4c8m2p0r6t9w3y5a7c1e/rotate-secret \
  -H "Authorization: Bearer $MONOTREE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "expire_previous_in": 3600
}'
200 · Response
{
    "id": "whe_01jd1f4c8m2p0r6t9w3y5a7c1e",
    "object": "webhook_endpoint",
    "url": "https://api.acme.example/hooks/monotree",
    "description": "Back office, production",
    "events": [
        "customer.live",
        "customer.failed"
    ],
    "active": true,
    "paused_at": "2026-11-12T09:41:00Z",
    "paused_reason": "manual",
    "secret": "string",
    "previous_secret_expires_at": "2026-11-12T09:41:00Z",
    "failed_24h": 0,
    "last_delivery": {
        "id": "whd_01jd1g2h3j4k5m6n7p8q9r0s1t",
        "status": "delivered",
        "response_code": 200,
        "created_at": "2026-11-12T09:42:18Z"
    },
    "sandbox": false,
    "created_at": "2026-11-10T14:05:00Z"
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

List deliveries

get /webhooks/{webhook}/deliveries webhooks:manage

The deliveries to the endpoint, newest first, with the status code your server answered. A delivery is one event sent to one endpoint, with all its tries. Deliveries are kept for 30 days. Ask for one delivery to see the body sent and your server's answer. A token only finds an endpoint whose events it may all read (the types it is subscribed to and the types among its deliveries); any other endpoint answers 404: see Which endpoints a token sees.

Parameters

webhook required

string · path

The webhook endpoint's ID (whe_…).

status

string · query

Only deliveries in this state: failed ones gave up after six tries, retrying ones have a try planned at next_attempt_at.

one of pending, delivered, retrying, failed

event_id

string · query

Only the deliveries of this event (evt_…), to see whether and how one event reached the endpoint.

event

string · query

Only deliveries of this event type.

limit

integer · query

How many to return in a page, 1 to 100.

default 25 · up to 100

cursor

string · query

The next_cursor of the page before, for the next page. Send the same filters with it.
Response · 200 A page of deliveries.

object

string

has_more

boolean

Whether there is a page after this one.

next_cursor

string, nullable

Pass as cursor for the next page.

data

array of objects

Errors

400 invalid_cursor: the cursor is not one this API gave out.
401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
404 not_found: no such webhook endpoint.
422 validation_error: a field is missing or invalid; fields says which.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl https://partners.monotree.com/api/v1/webhooks/whe_01jd1f4c8m2p0r6t9w3y5a7c1e/deliveries \
  -H "Authorization: Bearer $MONOTREE_TOKEN"
200 · Response
{
    "object": "list",
    "has_more": false,
    "next_cursor": "string",
    "data": [
        {
            "id": "whd_01jd1g2h3j4k5m6n7p8q9r0s1t",
            "object": "webhook_delivery",
            "event_id": "evt_01jcz8wg4h7v3y6n9q2k5m8p1r",
            "event": "customer.live",
            "status": "delivered",
            "attempts": 1,
            "redeliveries": 0,
            "response_code": 200,
            "duration_ms": 182,
            "next_attempt_at": null,
            "delivered_at": "2026-11-12T09:42:18Z",
            "created_at": "2026-11-12T09:42:18Z",
            "payload": {
                "id": "evt_01jcz8wg4h7v3y6n9q2k5m8p1r",
                "object": "event",
                "type": "customer.live",
                "api_version": "1.0.0",
                "created_at": "2026-11-12T09:42:18Z",
                "sandbox": false,
                "actor": {
                    "type": "system",
                    "name": "Monotree"
                },
                "data": {
                    "customer": {
                        "id": "cus_01jcz8w3k1x9q2v7s4e6m0b5n8",
                        "object": "customer",
                        "status": "live",
                        "company_name": "Boulangerie Martin",
                        "company_id": "boulangeriemartin",
                        "external_ref": "org_48213"
                    },
                    "details": {
                        "url": "https://boulangeriemartin.monotree.com",
                        "admin_email": "claire@boulangeriemartin.example"
                    }
                }
            },
            "response_body": "string"
        }
    ]
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Redeliver failed deliveries

post /webhooks/{webhook}/deliveries/redeliver-failed webhooks:manage

Queues the endpoint's failed deliveries of the last 24 hours again, up to 100, for example after your server was down. Each starts over as with Redeliver a delivery, but is sent from the queue rather than at once. A token only finds an endpoint whose events it may all read (the types it is subscribed to and the types among its deliveries); any other endpoint answers 404: see Which endpoints a token sees.

Parameters

webhook required

string · path

The webhook endpoint's ID (whe_…).

Accepts an optional Idempotency-Key header to make a retry safe.

Response · 202 The deliveries queued again, `pending`.

object

string

has_more

boolean

Whether there is a page after this one.

next_cursor

string, nullable

Pass as cursor for the next page.

data

array of objects

Errors

400 invalid_idempotency_key: the Idempotency-Key is longer than 255 characters.
401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
404 not_found: no such webhook endpoint.
409 endpoint_paused: the endpoint is paused; switch it on first. idempotency_in_progress: a call with the same Idempotency-Key is still running.
422 idempotency_key_reused: the Idempotency-Key was used for a different request.
429 rate_limited: more than 10 of these calls in an hour for this endpoint, or over the general limit. Wait for the number of seconds in Retry-After.
curl -X POST https://partners.monotree.com/api/v1/webhooks/whe_01jd1f4c8m2p0r6t9w3y5a7c1e/deliveries/redeliver-failed \
  -H "Authorization: Bearer $MONOTREE_TOKEN"
202 · Response
{
    "object": "list",
    "has_more": false,
    "next_cursor": "string",
    "data": [
        {
            "id": "whd_01jd1g2h3j4k5m6n7p8q9r0s1t",
            "object": "webhook_delivery",
            "event_id": "evt_01jcz8wg4h7v3y6n9q2k5m8p1r",
            "event": "customer.live",
            "status": "delivered",
            "attempts": 1,
            "redeliveries": 0,
            "response_code": 200,
            "duration_ms": 182,
            "next_attempt_at": null,
            "delivered_at": "2026-11-12T09:42:18Z",
            "created_at": "2026-11-12T09:42:18Z",
            "payload": {
                "id": "evt_01jcz8wg4h7v3y6n9q2k5m8p1r",
                "object": "event",
                "type": "customer.live",
                "api_version": "1.0.0",
                "created_at": "2026-11-12T09:42:18Z",
                "sandbox": false,
                "actor": {
                    "type": "system",
                    "name": "Monotree"
                },
                "data": {
                    "customer": {
                        "id": "cus_01jcz8w3k1x9q2v7s4e6m0b5n8",
                        "object": "customer",
                        "status": "live",
                        "company_name": "Boulangerie Martin",
                        "company_id": "boulangeriemartin",
                        "external_ref": "org_48213"
                    },
                    "details": {
                        "url": "https://boulangeriemartin.monotree.com",
                        "admin_email": "claire@boulangeriemartin.example"
                    }
                }
            },
            "response_body": "string"
        }
    ]
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Get a delivery

get /webhooks/{webhook}/deliveries/{delivery} webhooks:manage

One delivery, with the body sent (payload) and the first 2,000 bytes of your server's last answer (response_body). A token only finds an endpoint whose events it may all read (the types it is subscribed to and the types among its deliveries); any other endpoint answers 404: see Which endpoints a token sees.

Parameters

webhook required

string · path

The webhook endpoint's ID (whe_…).

delivery required

string · path

The delivery's ID (whd_…), as sent in the Monotree-Delivery header.
Response · 200 The delivery.

id

string

object

string

event_id

string

The id of the event that was sent.

event

string

The event type.

status

string

pending waiting for its first try · delivered your server answered 2xx · retrying a try failed and another is planned at next_attempt_at · failed given up after six tries.

one of pending, delivered, retrying, failed

attempts

integer

Tries made so far, of six at most (a test event is tried once). Sending the delivery again starts them over at 1; redeliveries says how often that happened.

redeliveries

integer

How many times the delivery was sent again by hand: with Redeliver a delivery, Redeliver failed deliveries or the button in the portal. 0 for a delivery that was never sent again.

response_code

integer, nullable

The status code of your server's last answer. Null when there was none (a timeout, no connection).

duration_ms

integer, nullable

next_attempt_at

string, nullable

delivered_at

string, nullable

created_at

string

payload

object

The event body sent, the same on every try. Only when one delivery is asked for, and only when the token may read events of this type.

id

string

The same on every delivery and redelivery of the event; also in the Monotree-Event-Id header. Keep it to skip repeats.

object

string

type

string

See the Event types guide.

api_version

string

The version of the API the event's data is written in; also in the Monotree-Api-Version header.

created_at

string

sandbox

boolean

actor

object, nullable

Who did it: a person in the portal (user), an API token (token, named API · <token name>) or Monotree itself (system). On support events also the assistant (assistant), and on support.message.received the person at the customer who wrote (customer).

type

string

one of user, token, system, assistant, customer

name

string

data

object

What the event is about, in the shapes the API returns. For a customer event: customer (the whole customer right after the event) and details. For a seller event: seller, always without two_factor, passkeys and last_login_at. The Event types guide says what each type carries.

response_body

string, nullable

The first 2,000 bytes of your server's last answer, or the error when there was none. Only when one delivery is asked for, and only when the token may read events of this type.

Errors

401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
404 not_found: no such webhook endpoint or delivery.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl https://partners.monotree.com/api/v1/webhooks/whe_01jd1f4c8m2p0r6t9w3y5a7c1e/deliveries/whd_01jd1g2h3j4k5m6n7p8q9r0s1t \
  -H "Authorization: Bearer $MONOTREE_TOKEN"
200 · Response
{
    "id": "whd_01jd1g2h3j4k5m6n7p8q9r0s1t",
    "object": "webhook_delivery",
    "event_id": "evt_01jcz8wg4h7v3y6n9q2k5m8p1r",
    "event": "customer.live",
    "status": "delivered",
    "attempts": 1,
    "redeliveries": 0,
    "response_code": 200,
    "duration_ms": 182,
    "next_attempt_at": null,
    "delivered_at": "2026-11-12T09:42:18Z",
    "created_at": "2026-11-12T09:42:18Z",
    "payload": {
        "id": "evt_01jcz8wg4h7v3y6n9q2k5m8p1r",
        "object": "event",
        "type": "customer.live",
        "api_version": "1.0.0",
        "created_at": "2026-11-12T09:42:18Z",
        "sandbox": false,
        "actor": {
            "type": "system",
            "name": "Monotree"
        },
        "data": {
            "customer": {
                "id": "cus_01jcz8w3k1x9q2v7s4e6m0b5n8",
                "object": "customer",
                "status": "live",
                "company_name": "Boulangerie Martin",
                "company_id": "boulangeriemartin",
                "external_ref": "org_48213"
            },
            "details": {
                "url": "https://boulangeriemartin.monotree.com",
                "admin_email": "claire@boulangeriemartin.example"
            }
        }
    },
    "response_body": "string"
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Redeliver a delivery

post /webhooks/{webhook}/deliveries/{delivery}/redeliver webhooks:manage

Sends the delivery again at once and answers with how it went. Works on failed deliveries and on delivered ones, to try a fix on your side. The delivery starts over: same delivery ID, same body and event id, attempts from 0, and the usual retries if this try fails. A retry that was planned is replaced, not added to. Refused while the endpoint is paused or a try is being sent. At most 10 redeliveries and test events a minute to one endpoint. A token only finds an endpoint whose events it may all read (the types it is subscribed to and the types among its deliveries); any other endpoint answers 404: see Which endpoints a token sees. The token must be able to read the delivery's event type.

Parameters

webhook required

string · path

The webhook endpoint's ID (whe_…).

delivery required

string · path

The delivery's ID (whd_…), as sent in the Monotree-Delivery header.

Accepts an optional Idempotency-Key header to make a retry safe.

Response · 202 The delivery, after the try.

id

string

object

string

event_id

string

The id of the event that was sent.

event

string

The event type.

status

string

pending waiting for its first try · delivered your server answered 2xx · retrying a try failed and another is planned at next_attempt_at · failed given up after six tries.

one of pending, delivered, retrying, failed

attempts

integer

Tries made so far, of six at most (a test event is tried once). Sending the delivery again starts them over at 1; redeliveries says how often that happened.

redeliveries

integer

How many times the delivery was sent again by hand: with Redeliver a delivery, Redeliver failed deliveries or the button in the portal. 0 for a delivery that was never sent again.

response_code

integer, nullable

The status code of your server's last answer. Null when there was none (a timeout, no connection).

duration_ms

integer, nullable

next_attempt_at

string, nullable

delivered_at

string, nullable

created_at

string

payload

object

The event body sent, the same on every try. Only when one delivery is asked for, and only when the token may read events of this type.

id

string

The same on every delivery and redelivery of the event; also in the Monotree-Event-Id header. Keep it to skip repeats.

object

string

type

string

See the Event types guide.

api_version

string

The version of the API the event's data is written in; also in the Monotree-Api-Version header.

created_at

string

sandbox

boolean

actor

object, nullable

Who did it: a person in the portal (user), an API token (token, named API · <token name>) or Monotree itself (system). On support events also the assistant (assistant), and on support.message.received the person at the customer who wrote (customer).

type

string

one of user, token, system, assistant, customer

name

string

data

object

What the event is about, in the shapes the API returns. For a customer event: customer (the whole customer right after the event) and details. For a seller event: seller, always without two_factor, passkeys and last_login_at. The Event types guide says what each type carries.

response_body

string, nullable

The first 2,000 bytes of your server's last answer, or the error when there was none. Only when one delivery is asked for, and only when the token may read events of this type.

Errors

400 invalid_idempotency_key: the Idempotency-Key is longer than 255 characters.
401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
404 not_found: no such webhook endpoint or delivery.
409 endpoint_paused: the endpoint is paused; switch it on first. delivery_in_progress: a try of this delivery is being sent right now. idempotency_in_progress: a call with the same Idempotency-Key is still running.
422 idempotency_key_reused: the Idempotency-Key was used for a different request.
429 rate_limited: more than 10 redeliveries and test events to this endpoint in a minute, or over the general limit. Wait for the number of seconds in Retry-After.
curl -X POST https://partners.monotree.com/api/v1/webhooks/whe_01jd1f4c8m2p0r6t9w3y5a7c1e/deliveries/whd_01jd1g2h3j4k5m6n7p8q9r0s1t/redeliver \
  -H "Authorization: Bearer $MONOTREE_TOKEN"
202 · Response
{
    "id": "whd_01jd1g2h3j4k5m6n7p8q9r0s1t",
    "object": "webhook_delivery",
    "event_id": "evt_01jcz8wg4h7v3y6n9q2k5m8p1r",
    "event": "customer.live",
    "status": "delivered",
    "attempts": 1,
    "redeliveries": 0,
    "response_code": 200,
    "duration_ms": 182,
    "next_attempt_at": null,
    "delivered_at": "2026-11-12T09:42:18Z",
    "created_at": "2026-11-12T09:42:18Z",
    "payload": {
        "id": "evt_01jcz8wg4h7v3y6n9q2k5m8p1r",
        "object": "event",
        "type": "customer.live",
        "api_version": "1.0.0",
        "created_at": "2026-11-12T09:42:18Z",
        "sandbox": false,
        "actor": {
            "type": "system",
            "name": "Monotree"
        },
        "data": {
            "customer": {
                "id": "cus_01jcz8w3k1x9q2v7s4e6m0b5n8",
                "object": "customer",
                "status": "live",
                "company_name": "Boulangerie Martin",
                "company_id": "boulangeriemartin",
                "external_ref": "org_48213"
            },
            "details": {
                "url": "https://boulangeriemartin.monotree.com",
                "admin_email": "claire@boulangeriemartin.example"
            }
        }
    },
    "response_body": "string"
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…