Create a destination

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 each change as a German text message; 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 destination safe to retry. 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.

Free.

Authorization

bearerAuth

AuthorizationBearer <token>

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

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. Use a random UUID.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A new destination.

channel*Channel

How a notification is delivered. email sends a message; webhook POSTs a signed JSON body to your URL; slack posts a message to a Slack channel through an incoming webhook.

Value in

"email"
"webhook"
"slack"

cadence?string

How often this destination is told. Optional: daily for email and slack, instant for webhook. A webhook is told at once (instant) for now.

Value in

"instant"
"daily"
"weekly"
"monthly"

address*string

An e-mail address when channel is email, an absolute http/https URL when it is webhook, and the incoming-webhook URL Slack issued when it is slack (https://hooks.slack.com/services/…, nothing else). A bare address: a display-name form (Ops Team <ops@example.com>) is refused, because it and the address alone would count as two different addresses.

Length1 <= length <= 2048

metadata?

Your own key-value pairs on an object you created: a CRM id, an internal reference, anything you want to find again. Registercheck stores and returns them and never acts on them. Stripe's limits: at most 50 keys, keys at most 40 characters and without square brackets, values strings of at most 500 characters. Do not store secrets or personal data here.

Propertiesproperties <= 50

Response Body

`application/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": "email",    "address": "string"  }'

{  "id": "dst_6hq30w96je9rnrmw1tknzhwb2n",  "object": "destination",  "channel": "email",  "address": "string",  "cadence": "instant",  "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"}

Authorization

Header Parameters

Request Body

Response Body

201application/json

400application/problem+json

401application/problem+json

409application/problem+json

429application/problem+json

500application/problem+json

503application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`