Webhooks

Delete an event webhook and its delivery log

Operation ID: deleteWebhook

DELETE
/webhooks/{webhookId}

Removes the endpoint for good, with its delivery log.

Needs an API key with the manage scope.

Authorization

apiKey
headerAuthorizationBearer <oq_ followed by 43 letters and digits>

An Outqube API key, made in the app's settings. It belongs to one app and has the scope read, trigger or manage; a higher scope includes the lower ones. A revoked or expired key is a 401.

Path Parameters

webhookId*string

The endpoint's id.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

OK

application/json
  1. response
id*string

The deleted endpoint's id.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
deleted*boolean

Always true.

Example Request
curl -X DELETE 'https://app.outqube.com/api/v1/webhooks/d8f0b2a4-6c1e-4d73-9a5b-1c3e5a7b9d46'
Example Response
{  "id": "d8f0b2a4-6c1e-4d73-9a5b-1c3e5a7b9d46",  "deleted": true}