Docs
Webhooks

Remove a webhook endpoint

DELETEhttps://api.norreach.app/v1/webhook-endpoints/{id}

Stops all deliveries to it and removes its delivery log.

webhooks:writeRole must allow: api.keysOperation id: delete_webhook_endpoint
DELETE/webhook-endpoints/{id}
curl -X DELETE "https://api.norreach.app/v1/webhook-endpoints/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Remove a webhook endpoint
{
  "id": "0f1a2b3c-4d5e-4f6a-8b7c-9d0e1f2a3b4c",
  "object": "webhook_endpoint",
  "deleted": true
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope webhooks:write. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Headers

Idempotency-Keystringheader

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Response

200application/json— Remove a webhook endpoint

idstring (uuid)required

An id (UUID).

object"webhook_endpoint"required
deletedtruerequired

Errors

Errors are application/problem+json with a stable code.

StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
401unauthorizedA valid API key is required.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403feature_not_enabledThe API isn't switched on for this workspace.
403role_forbiddenThe key's creator's role can't do this.
404not_foundThat doesn't exist.
409idempotency_in_progressA request with this Idempotency-Key is still running.
413too_largeThe request body is too large.
422validation_failedThe request has invalid fields.
422idempotency_mismatchThis Idempotency-Key was used with a different request.
429rate_limitedToo many requests. Slow down and try again.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.