Recipient status changed

Triggered when a v3 recipient enters a new public state.

default

{
  "id": "evt_abc123",
  "type": "recipient.status_changed",
  "createdAt": "2026-07-04T12:00:00.000Z",
  "attempt": 1,
  "resource": {
    "type": "recipient",
    "id": "rcp_abc123"
  },
  "data": {
    "object": {
      "id": "rcp_abc123",
      "customerId": "cus_abc123",
      "type": "individual",
      "relationship": "vendor",
      "status": "rejected",
      "firstName": "Ada",
      "lastName": "Lovelace",
      "createdAt": "2026-07-04T12:00:00.000Z",
      "updatedAt": "2026-07-04T12:30:00.000Z",
      "archivedAt": null
    },
    "previous": {
      "state": "active"
    }
  }
}

Authorizations

X-API-Key · string · header · required

Body

application/json

id · string · required

Stable webhook event id for deduplication.

type · string · required

Allowed value: "recipient.status_changed"

createdAt · string<date-time> · required

attempt · enum<integer> · required

Envelope attempt value; currently always 1 and unchanged by delivery retries.

Available options: 1

resource · object · required

Show child attributes

data · object · required

Show child attributes

Response

200

Webhook accepted by the merchant endpoint.