repush
Webhook Events
Introduction
- Welcome to Nomba
- Get API Keys
- Testing
Getting Started
- Dashboard Setup
- Authentication
- Definitions
Plugins and SDKs
Products
- Accounts
- Accept Payments
- Transfers
- Terminals
- Webhooks
- Transactions
- Airtime & Data Vending
- Cable & Bill Payments
Guides
API Patterns
repush
Webhook Events
Learn how to fetch all webhook event types.
curl --location 'https://api.nomba.com/v1/webhooks/events' \
--header 'Authorization: Bearer TOKEN \
--header 'Content-Type: application/json' \
--header 'accountId: 670353d1-158a-XXXXXXXXX'\
--data '{
"coreUserId": "6703XXXd1-158a-42XX-8f0b-XXXXXXXXX",
"limit": 20
}'
{
"code": "200",
"description": "Webhook events fetched successfully",
"data": {
"list": [
{
"webHookId": 782,
"eventURL": "https://hip-guinea-supr.net",
"description": "new",
"eventType": "order_success",
"enabled": true
},
{
"webHookId": 257,
"eventURL": "https://hip-guinea-supr.net",
"description": "new",
"eventType": "payment_success",
"enabled": true
}
],
"pageToken": ""
}
}
When a business or user subscribes to an event type on the dashboard, they can use this endpoint to fetch the webhook event types that they subscribe to.
POST /v1/webhooks/events
Request Body
The unique identifier of the user or business whose webhook events are to be retrieved.
The number of records to return. Default is 20.
Response Body
Response code indicating the status of the request.
Description of the response.
A list of webhook event types and their configurations.
Unique identifier of the webhook configuration.
The URL configured to receive the webhook event.
Optional description for the webhook.
Type of webhook event (e.g., payment_success
).
Indicates whether this webhook is active.
Token for paginating additional results, if any.
curl --location 'https://api.nomba.com/v1/webhooks/events' \
--header 'Authorization: Bearer TOKEN \
--header 'Content-Type: application/json' \
--header 'accountId: 670353d1-158a-XXXXXXXXX'\
--data '{
"coreUserId": "6703XXXd1-158a-42XX-8f0b-XXXXXXXXX",
"limit": 20
}'
{
"code": "200",
"description": "Webhook events fetched successfully",
"data": {
"list": [
{
"webHookId": 782,
"eventURL": "https://hip-guinea-supr.net",
"description": "new",
"eventType": "order_success",
"enabled": true
},
{
"webHookId": 257,
"eventURL": "https://hip-guinea-supr.net",
"description": "new",
"eventType": "payment_success",
"enabled": true
}
],
"pageToken": ""
}
}
curl --location 'https://api.nomba.com/v1/webhooks/events' \
--header 'Authorization: Bearer TOKEN \
--header 'Content-Type: application/json' \
--header 'accountId: 670353d1-158a-XXXXXXXXX'\
--data '{
"coreUserId": "6703XXXd1-158a-42XX-8f0b-XXXXXXXXX",
"limit": 20
}'
{
"code": "200",
"description": "Webhook events fetched successfully",
"data": {
"list": [
{
"webHookId": 782,
"eventURL": "https://hip-guinea-supr.net",
"description": "new",
"eventType": "order_success",
"enabled": true
},
{
"webHookId": 257,
"eventURL": "https://hip-guinea-supr.net",
"description": "new",
"eventType": "payment_success",
"enabled": true
}
],
"pageToken": ""
}
}