Organisation Webhook Events

For details of the common root-level properties of webhook event objects, see Webhooks.

See below for example webhook events.

Onboarding Update

status is as described in Organisation Statuses

{
  "eventId": "9b319b78-bdc8-4970-a175-5cac83afd3fa",
  "type": "OrganisationOnboarding",
  "id": "1d7ae118-611c-4f50-a01a-e80a3ece3716",
  "parentType": null,
  "parentId": null,
  "status": "Complete",
  "timestamp": "2024-06-28T14:47:41.3051867Z",
  "organisationId": "1d7ae118-611c-4f50-a01a-e80a3ece3716",
  "partnerClientId": "crezdemo_1719586044",
  "partnerEntityId": null,
  "parentPartnerEntityId": null,
  "payload": null,
  "version": "2024-06-30"
}

Verification Update

status is as described in Organisation Statuses
payload in Failed Verification updates indicates whether the Organisation is able to restart Verification through Verification flow ("canRetry": true) to try again, or not ("canRetry": false)

{
  "eventId": "7d13e347-2b07-4e52-85b6-4f5d6b5f20ff",
  "type": "Verification",
  "id": "f51390b7-f258-46d3-9827-d7feb731953b",
  "parentType": null,
  "parentId": null,
  "status": "Completed",
  "timestamp": "2024-06-28T13:32:12.1082924Z",
  "organisationId": "f51390b7-f258-46d3-9827-d7feb731953b",
  "partnerClientId": "FXtest22",
  "partnerEntityId": null,
  "parentPartnerEntityId": null,
  "payload": null,
  "version": "2024-06-30"
}

{
  "eventId": "2897f3c6-ac11-4d09-af3e-f3924263947f",
  "type": "Verification",
  "id": "3302ac1b-661c-4775-8fd7-74a40e14f959",
  "parentType": null,
  "parentId": null,
  "status": "Failed",
  "timestamp": "2024-08-13T13:20:44.3685869Z",
  "organisationId": "3302ac1b-661c-4775-8fd7-74a40e14f959",
  "partnerClientId": "crezdemo_1723554696",
  "partnerEntityId": null,
  "parentPartnerEntityId": null,
  "payload": {
     "canRetry": false
   },
   "version": "2024-06-30"
}

Features Update

payload is an array of Features as described in Get Organisation

{
  "eventId": "643473c9-9605-4161-9948-a6f24043a2c9",
  "type": "Feature",
  "id": "f51390b7-f258-46d3-9827-d7feb731953b",
  "parentType": null,
  "parentId": null,
  "status": "enabled",
  "timestamp": "2024-06-28T13:32:12.1082924Z",
  "organisationId": "f51390b7-f258-46d3-9827-d7feb731953b",
  "partnerClientId": "FXtest22",
  "partnerEntityId": null,
  "parentPartnerEntityId": null,
  "payload": [
    {
      "id": "DomesticPayments",
      "enabled": true,
      "lastUpdatedUtc": "2024-06-28T13:23:24.6391981"
    },
    {
      "id": "InternationalPayments",
      "enabled": true,
      "lastUpdatedUtc": "2024-06-28T13:32:12.1352261Z"
    }
  ],
  "version": "2024-06-30"
}