Create a notification endpoint
Add a place to send your notifications: an e-mail address, or a webhook URL.
A webhook's secret is in this response and in no other. Store it now — it is the
key your server verifies our svix-signature header with, and no later request will
return it. An email endpoint has no secret.
One live endpoint per destination. Adding a destination you already have answers 409
with its id in existing_id; disable it first if you want to recreate it.
An Idempotency-Key makes creating an email endpoint safe to retry. Creating a
webhook endpoint is not replayed, because its secret is never stored a second time: a
retry after a lost response answers 409 with existing_id -- disable that endpoint and
create a new one to get a new secret.
Free.
Authorization
bearerAuth Your API key, sent as Authorization: Bearer rc_live_….
In: header
Header Parameters
Makes a retry safe. A request repeated with the same key within 24 hours returns
the first successful response (with Idempotent-Replayed: true) instead of acting
twice; an error is not stored, so its retry runs again. Reusing a key with a different
body returns 422; retrying while the first request is still running returns 409.
Use a random UUID.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A new notification endpoint.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://api.registercheck.de/v1/notification-endpoints" \ -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "channel": "email", "destination": "string" }'{ "id": "string", "object": "notification_endpoint", "channel": "email", "destination": "string", "disabled": true, "disabled_at": "2019-08-24T14:15:22Z", "disabled_reason": "string", "usable": true, "unusable_reason": "string", "metadata": { "crm_id": "0015g00000XyZ", "team": "kyc" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "secret": "string"}