registercheckby openlaw group
API referenceDestinations

Create a destination

POST
/destinations

Add a place to send your notifications: an e-mail address, a webhook URL, or a Slack channel's incoming webhook ("channel": "slack", with the URL Slack issued as address). A Slack destination posts a short text message in your workspace's language (German unless it is set to English): each change when its cadence is instant, otherwise one digest per period. Its URL is shown in full in this response only.

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 destination has no secret.

One live destination per address. Adding an address 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 or slack destination safe to retry (a replay repeats the first answer, a Slack URL in full included). Creating a webhook destination 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 destination and create a new one to get a new secret.

Adding an address that one of your dashboard monitors already delivers to (a route destination) makes that destination yours instead of answering 409: role becomes own, and secret is null -- it was shown when the route was created.

Free.

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer rc_prod_….

In: header

Header Parameters

Idempotency-Key?string

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. A response that carries a webhook's signing secret is not stored: retrying such a POST /destinations answers 409 with existing_id. Use a random UUID.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A new destination.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://api.registercheck.de/v1/destinations" \  -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "channel": "webhook",    "address": "https://example.com/webhooks/registercheck",    "cadence": "instant",    "metadata": {      "crm_id": "0015g00000XyZ"    }  }'
{  "object": "destination",  "id": "dst_6hq30w96je9rnrmw1tknzhwb2n",  "channel": "webhook",  "address": "https://example.com/webhooks/registercheck",  "cadence": "instant",  "role": "own",  "disabled": false,  "disabled_at": null,  "disabled_reason": null,  "usable": true,  "unusable_reason": null,  "requires_plan": null,  "metadata": {    "crm_id": "0015g00000XyZ"  },  "created_at": "2024-05-20T08:15:00Z",  "updated_at": "2024-05-20T08:15:00Z",  "enabled_events": [    "delivery"  ],  "secret": "whsec_ZXhhbXBsZS1zZWNyZXQtZm9yLWRvY3Mh"}