Skip to main content

Hooks API — Delete

Written by Marcus Warren

Use this endpoint to permanently remove a webhook subscription from your account.


Endpoint

DELETE https://e1.envoke.com/v1/hooks/{ID}.json

Replace {ID} with the 32-character hex subscription ID. Authentication is via HTTP Basic Auth using your API ID and API Key.


Important

Deletion is permanent. Once a subscription is deleted, Envoke will no longer deliver events to that URL for that event type. The deletion cannot be undone via the API — you must create a new subscription if you want to resume delivery.

Deletion is idempotent. If the subscription ID does not exist, the API still returns a success response. This makes it safe to call DELETE more than once.


Response

On success (or when the ID does not exist):

{   "success": true,   "result_text": "Deleted",   "result_data": [] }

Example

curl -X DELETE -ks \   -u "$API_ID:$API_KEY" \   "$BASE/v1/hooks/9f1c2a42baedb56c7e65b3eeaf1a8814.json"

Replace 9f1c2a42baedb56c7e65b3eeaf1a8814 with the ID of the subscription you want to delete. Use GET /v1/hooks.json to list your subscriptions and find the correct ID.


Automatic Deletion

Envoke automatically removes a subscription if your endpoint responds with HTTP 410 Gone. Use this to programmatically deregister a subscription from the receiving side when it is no longer needed.


Note: The curl examples above are formatted for readability. All requests must use properly encoded URLs.

For code examples and interactive testing, visit api.envoke.com.

Did this answer your question?