---
title: "Recipient state change"
method: POST
path: "recipients#state-change"
tags: ["webhook-event", "recipient"]
---

# Recipient state change

`POST recipients#state-change` (webhook)

Triggered when a recipient account created or changed through hosted recipient creation changes state.
See the [Embedded Flows guide](/guides/product/embedded-flows/index.md#hosted-recipient-creation-flow) for an example recipient creation flow.

Events may not be delivered in the order they occurred. Use `data.resource.occurred_at` to reconcile the order.
See the [Event Ordering](/guides/developer/webhooks/event-ordering) guide for details.

* Event type: `recipients#state-change`
* Profile level subscriptions: Supported
* Application level subscriptions: Supported

## Headers

- `X-Signature-SHA256` string
- `X-Delivery-Id` string, uuid
- `X-Test-Notification` boolean

## Payload

- V40029
  - `schema_version` '4.0.0', required — Version of the event schema. Determined by the `schema_version` on your [webhook subscription](/api-reference/webhook).
  - `subscription_id` string, uuid, required — ID of the webhook subscription that triggered this event.
  - `event_type` 'recipients#state-change', required — Event type identifier.
  - `sent_at` string, date-time, required — Timestamp when the event was sent.
  - `data` object, required
    - `resource` object, required
      - `id` string, required — Resource identifier for the changed recipient.
      - `occurred_at` string, date-time, required — Timestamp when the recipient state change occurred.
      - `data` object, required
        - `recipientId` integer, required — Recipient account ID.
        - `profileId` integer, required — Profile ID that owns the recipient.
        - `currency` string, required — Recipient account currency.
        - `state` 'CREATE' | 'UPDATE' | 'DEACTIVATE' | 'OBFUSCATE' | 'DELETE', required — Recipient state that triggered the event.
        - `clientId` string, required — Partner client ID associated with the recipient.

## Acknowledgement `200`

Return any `2xx` status to acknowledge receipt of the event.

- object
  - `status` string

---

[API](https://skmtc.net/wise/apis/platform-api.md) · [All operations](https://skmtc.net/wise/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wise/platform-api/revisions/4907a1d269ab/schema)