Update Webhooks

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Updates a webhook. Send id and only the fields you want to change.

📘

Event deliveries

Vendy sends each event as a JSON POST with an x-signature header. See the Webhooks overview for the event list and how to check signatures.

Request:

FieldInTypeRequiredDescription
idBodyStringYesThe webhook's id
urlBodyStringNoHTTPS URL that receives the events
allowedEventsBodyStringNoOne 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
retryStatusBodyEnum (String)NoENABLED or DISABLED: whether failed deliveries are retried
secretHashBodyStringNoSecret used as the HMAC-SHA256 key to sign each event. See Validating Webhook Signatures
businessIdQueryIntegerNoIgnored when you use API keys. See Authentication

Example request

curl --location 'https://api.myvendy.com/webhooks/update-webhook' \
--header 'Content-Type: application/json' \
--header "AccessKey: $VENDY_ACCESS_KEY" \
--header "SecretKey: $VENDY_SECRET_KEY" \
--data '{
    "id": "39a1e4bf-fbc3-4b78-9555-c50f8cfa17bw",
    "allowedEvents": "transaction_success",
    "retryStatus": "DISABLED"
}'

Response:

FieldTypeDescription
statusBooleanStates if request was successfully executed or not
codeIntegerInternal code, success if 200
msgStringThe webhook service's message, usually success
dataWebhookUpdated webhook details

Example response

{
    "status": true,
    "code": 200,
    "msg": "success",
    "error": "success",
    "data": {
        "allowedEvents": "transaction_success",
        "clientId": "39a1e4bf-fbc3-4b78-9555-c50f8cfa17bw",
        "created": "2026-10-20T07:05:40.432Z",
        "id": "39a1e4bf-fbc3-4b78-9555-c50f8cfa17bw",
        "retryStatus": "DISABLED",
        "secretHash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
        "updated": "2026-10-20T07:05:40.432Z",
        "url": "https://example.com/webhook"
    }
}

Possible errors

Error codeDescription
218The webhook service rejected the request. msg says why, for example an unknown id
342Your keys lack permission to manage webhooks
Query Params
string

Required when you call with a dashboard session token. With AccessKey/SecretKey it is ignored: the business comes from the key.

Body Params
string
required

webhook id to be updated

string

webhook url

string

ENABLED or DISABLED

string
string
enum

One event, or all.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json