post
https://api.myvendy.com/webhooks/delete-webhook
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Deletes a webhook. Vendy stops sending it events.
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 |
|---|---|---|---|---|
| id | Body | String | Yes | The webhook's id |
| businessId | Query | Integer | No | Ignored when you use API keys. See Authentication |
Example request
curl --location 'https://api.myvendy.com/webhooks/delete-webhook' \
--header 'Content-Type: application/json' \
--header "AccessKey: $VENDY_ACCESS_KEY" \
--header "SecretKey: $VENDY_SECRET_KEY" \
--data '{
"id": "39a1e4bf-fbc3-4b78-9555-c50f8cfa17bw"
}'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 | JSON | Empty |
Example response
{
"status": true,
"code": 200,
"msg": "success",
"error": "success",
"data": {}
}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 |