Documentation menu

← Webhooks

API reference

Delete a webhook

DELETE/v1/webhook/{webhook}

Deletes a webhook.

Its pending deliveries are dead-lettered, and past deliveries can still be retrieved by id. Send the ETag you read as If-Match. This cannot be undone.

Parameters

path

webhookrequiredstring
The webhook's id, whk_....

header

If-Matchstring | null
The ETag from your last read of the webhook. A stale value is refused with 409.

Responses

204
empty
No content.
401
ProblemDetail
credential_missing, credential_invalid or credential_expired. The request has no valid credential.
403
ProblemDetail
scope_missing, person_required, api_key_not_accepted or entitlement_missing. The credential or plan does not allow this request. detail names the reason.
404
ProblemDetail
no_such_resource. No object has that id.
409
ProblemDetail
version_conflict. The object changed after it was read. Read it again and resend with the new ETag in If-Match.
422
ProblemDetail
parameter_invalid, id_malformed or a cursor code. A parameter is missing or invalid. errors lists each one.
429
ProblemDetail
rate_limited. Too many requests. Retry after the Retry-After interval. Nothing is charged.

Credits

Free.

Example request

curl -X DELETE 'https://api.placestack.com/v1/webhook/018f4b75-6f79-7c6a-8c80-000000000001' \
  -H "Authorization: Bearer $PLACESTACK_API_KEY"

Next steps

GET /webhook/{webhook}/delivery

List deliveries

Continue