Retrieve List Of Webhook Configurations

Retrieve list of webhook configurations

curl --request GET \
  --url https://api-sandbox.orum.io/webhooks/configurations \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'

{
  "webhook_configurations": [
    {
      "id": "<string>",
      "enterprise_name": "<string>",
      "data_version": "v2022-09-21",
      "event_types": [
        "subscribe_all"
      ],
      "enabled": true,
      "url": "<string>",
      "created_at": "<string>",
      "created_by": "<string>",
      "updated_at": "<string>",
      "updated_by": "<string>"
    }
  ]
}

GET

webhooks

configurations

Retrieve list of webhook configurations

curl --request GET \
  --url https://api-sandbox.orum.io/webhooks/configurations \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'

{
  "webhook_configurations": [
    {
      "id": "<string>",
      "enterprise_name": "<string>",
      "data_version": "v2022-09-21",
      "event_types": [
        "subscribe_all"
      ],
      "enabled": true,
      "url": "<string>",
      "created_at": "<string>",
      "created_by": "<string>",
      "updated_at": "<string>",
      "updated_by": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Orum-Version

enum<string>

required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:

v2022-09-21

Response

200 response.

webhook_configurations

WebhookConfiguration · object[]

required

An array of webhook configurations.

Show child attributes

webhook_configurations.id

string

required

webhook_configurations.enterprise_name

string

required

webhook_configurations.data_version

enum<string>

required

data_version is set by the Orum-Version used to create or update the webhook configuration. A webhook configuration with data_version v2022-09-21 will match the v2022-09-21 schema for the given event type.

Available options:

v2022-09-21,

v2021-10-01

webhook_configurations.event_types

enum<string>[]

required

The types of events for which you would like to receive a webhook e.g. transfer_created. Use subscribe_all to receive webhooks for all events.

The type of event you want to invoke a webhook for.

Available options:

subscribe_all,

person_created,

person_verified,

person_rejected,

person_restricted,

person_unverified,

person_closed,

person_all,

business_created,

business_verified,

business_rejected,

business_restricted,

business_unverified,

business_closed,

business_all,

external_account_created,

external_account_verified,

external_account_rejected,

external_account_restricted,

external_account_unverified,

external_account_closed,

external_account_all,

transfer_updated,

transfer_all,

verify_account_updated,

subledger_all,

subledger_created,

book_transfer_all,

book_transfer_updated

webhook_configurations.enabled

boolean

required

webhook_configurations.url

string

required

webhook_configurations.created_at

string

required

webhook_configurations.created_by

string

required

webhook_configurations.updated_at

string

required

webhook_configurations.updated_by

string

required

Create Webhook Configuration Update Webhook Configuration

⌘I

Auth API

Deliver API

Verify API

Webhooks API

Retrieve List Of Webhook Configurations

Authorizations

Headers

Response