Docs
REST API v1

Remove a webhook

Remove a webhook in the authenticated project environment.

DELETE/v1/webhooks/{endpointId}

Requirements

A secret API key with webhooks:write. Resources are restricted to the key's project and environment.

Path parameters

NameTypeRequired / defaultDescription
endpointIdstringRequiredID returned when creating the webhook.

Query parameters

NameTypeRequired / defaultDescription
projectIdstringKey projectMust match the key's project.
environmentIdstringKey environmentMust match the key's environment.

Example

Set RELAYRTC_API_URL to your API base including /v1, such as http://localhost:8082/v1.

Shell
curl -X DELETE "$RELAYRTC_API_URL/webhooks/webhook_example" \
  -H "Authorization: Bearer $RELAYRTC_SECRET_KEY"

Response

204 with no response body.

Notes

Remove the receiver configuration

This removes the endpoint from RelayRTC. It does not delete the receiver route in your own application.

Errors

Invalid fields return 400. Invalid credentials return 401; a missing scope returns 403. A missing resource returns 404. See error responses.