Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
webhook

Create Profile Webhook Subscription

Create a webhook subscription at the profile level.

post/v3/profiles/{profileId}/subscriptions

Path parameters

profileIdinteger required

ID of the profile you are subscribing to.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Request body

namestring required

A custom name for your webhook to ease with identification.

trigger_onstring required

Choose from a list of available events.

Example request

{
  "name": "Webhook Subscription #1",
  "trigger_on": "transfers#state-change",
  "delivery": {
    "version": "4.0.0",
    "url": "https://your.webhook.url/12345"
  }
}

Response

OK

idstring uuid

UUID that uniquely identifies the subscription.

namestring

A custom name for your webhook to ease with identification.

trigger_onstring

The event type this subscription is listening for. List of available events.

created_atstring date-time

Timestamp of when the subscription was created.

Example response

{
  "id": "72195556-e5cb-495e-a010-b37a4f2a3043",
  "name": "Webhook Subscription #1",
  "trigger_on": "transfers#state-change",
  "delivery": {
    "version": "4.0.0",
    "url": "https://your.webhook.url/12345"
  },
  "scope": {
    "domain": "application",
    "id": "<your client key>"
  },
  "created_by": {
    "type": "application",
    "id": "<your client ID>"
  },
  "created_at": "2019-10-10T13:55:57Z"
}