Delete a webhook endpoint

DELETEhttps://api.getstarted.ae/v1/webhooks/{id}

Stops delivery to the endpoint immediately. Events already queued are dropped.

Path parameters

  • idstringrequired

    ID of the webhook endpoint, e.g. whk_01J9ZKJ3GX7N2S.

Responses

  • 200OK. Returns the object shown in the example.
  • 404resource_not_found No webhook endpoint with that ID exists in this environment.
  • Every endpoint can also return 401 for a missing or invalid key. See Errors.
curl -X DELETE "https://api.getstarted.ae/v1/webhooks/whk_01J9ZKJ3GX7N2S" \
  -H "Authorization: Bearer $GETSTARTED_API_KEY"
Response · 200
{
  "id": "whk_01J9ZKJ3GX7N2S",
  "object": "webhook",
  "deleted": true
}