post
https://api.myvendy.com/webhooks/create-webhook
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Creates a webhook. Vendy then sends the events you choose to url.
Event deliveriesVendy sends each event as a JSON
POSTwith anx-signatureheader. See the Webhooks overview for the event list and how to check signatures.
Request:
| Field | In | Type | Required | Description |
|---|---|---|---|---|
| url | Body | String | Yes | HTTPS URL that receives the events |
| allowedEvents | Body | String | No | One event to send: all, transaction_success, transaction_failed, transaction_cancelled, transaction_updated, payout_received, payout_completed, payout_failed, payout_cancelled, virtual_account_funded or wallet_funded |
| retryStatus | Body | Enum (String) | Yes | ENABLED or DISABLED: whether failed deliveries are retried |
| secretHash | Body | String | Yes | Secret used as the HMAC-SHA256 key to sign each event. See Validating Webhook Signatures |
| businessId | Query | Integer | No | Ignored when you use API keys. See Authentication |
Example request
curl --location 'https://api.myvendy.com/webhooks/create-webhook' \
--header 'Content-Type: application/json' \
--header "AccessKey: $VENDY_ACCESS_KEY" \
--header "SecretKey: $VENDY_SECRET_KEY" \
--data '{
"url": "https://example.com/webhook",
"allowedEvents": "all",
"retryStatus": "ENABLED",
"secretHash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
}'Response:
| Field | Type | Description |
|---|---|---|
| status | Boolean | States if request was successfully executed or not |
| code | Integer | Internal code, success if 200 |
| msg | String | The webhook service's message, usually success |
| data | Webhook | Newly created webhook |
Example response
{
"status": true,
"code": 200,
"msg": "success",
"error": "success",
"data": {
"allowedEvents": "all",
"clientId": "39a1e4bf-fbc3-4b78-9555-c50f8cfa17bw",
"created": "2026-10-20T07:05:40.432Z",
"id": "39a1e4bf-fbc3-4b78-9555-c50f8cfa17bw",
"retryStatus": "ENABLED",
"secretHash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
"updated": "2026-10-20T07:05:40.432Z",
"url": "https://example.com/webhook"
}
}Possible errors
| Error code | Description |
|---|---|
218 | The webhook service rejected the request. msg says why, for example an unknown id |
342 | Your keys lack permission to manage webhooks |