Skip to main content
POST
/
v1
/
notifications
/
destinations
Create a destination (verified on save via a test post)
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/notifications/destinations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "target_id": "<string>",
  "target_label": "<string>",
  "channel_kind": "slack",
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "channel_kind": "<string>",
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "target_id": "<string>",
  "target_label": "<string>",
  "verified_at": "2023-11-07T05:31:56Z",
  "enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Body

application/json

Create (or re-verify) a destination. Verified on save via a test post.

target_id
string
required
Minimum string length: 1
target_label
string
required
Minimum string length: 1
channel_kind
enum<string>
default:slack

The messaging channel a destination delivers through.

slack is the only kind in v1. New kinds are additive — add a member here, a provider class, and a PROVIDER_REGISTRY entry.

Available options:
slack
connection_id
string<uuid> | null

Response

Successful Response

id
string<uuid>
required
organization_id
string<uuid>
required
channel_kind
string
required
connection_id
string<uuid>
required
target_id
string
required
target_label
string
required
verified_at
string<date-time> | null
required
enabled
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required