Configure webhooks
Retrieve List Of Webhook Configurations
Auth API
- How to authenticate
Deliver API
- Persons
- Businesses
- External Accounts
- Cards
- Transfers
- Eligibility
- Transfer Groups
- Balance
- Reports
Verify API
Webhooks API
- Overview And Set Up
- Event Types and Payloads
- Configure webhooks
- Trigger webhooks
- Secure webhooks
Configure webhooks
Retrieve List Of Webhook Configurations
GET
/
webhooks
/
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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Version of Deliver API. Use v2022-09-21.
Available options:
v2022-09-21
Response
200 - application/json
200 response.
An array of webhook configurations.
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
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
Was this page helpful?
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>"
}
]
}