Skip to content

API reference

Destinations

Destinations are the Slack, Microsoft Teams, Discord, Google Chat, Mattermost and Telegram chats and the webhooks flows deliver to. Email needs no destination.

List destinations

GEThttps://formpik.com/api/v1/destinations

Read one destination

GEThttps://formpik.com/api/v1/destinations/{id}
200 OK
{
  "data": {
    "id": "dst_s4l2c8k1q0",
    "kind": "webhook",
    "name": "CRM",
    "target": "",
    "url": "https://crm.yourcompany.com/hooks/formpik",
    "signing_secret": "whsec_...",
    "created_at": "2026-11-04T12:00:00.000Z"
  }
}

Connect a destination

POSThttps://formpik.com/api/v1/destinations

Answers 201. A webhook gets its signing secret here. Needs a key with full or admin access.

Body

kindstringrequired
slack, teams, discord, googlechat, mattermost, telegram or webhook. It cannot change later. For Telegram, target is the chat ID.
urlstringrequired
The incoming webhook address from Slack, Teams or Discord, or your own https address. Private network addresses are refused.
namestring
Up to 100 characters.
targetstring
A note shown in the dashboard, such as the channel: #sales-leads.
cURL
curl -X POST "https://formpik.com/api/v1/destinations" \
  -H "Authorization: Bearer $FORMPIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind": "slack", "name": "Sales channel", "target": "#sales-leads", "url": "https://hooks.slack.com/services/..."}'

Change a destination

PATCHhttps://formpik.com/api/v1/destinations/{id}

Send any of name, target and url. Needs a key with full or admin access.

Disconnect a destination

DELETEhttps://formpik.com/api/v1/destinations/{id}

Steps that delivered to it need a new destination before their flows can go live again. Needs a key with full or admin access.

To use one in a flow, put its id in a step's destination_id. See Steps and connections.