Connectors API

Receive notifications on third-party platforms like Slack, Discord, and Microsoft Teams.

Quick Start

Generate an API token from your account settings
Get a webhook URL from your preferred platform (Slack, Discord, etc.)
Create a connector via the API
Select which events you want to receive
Start receiving notifications!

Available Connector Types

Type	Description	Required Fields
`slack`	Post notifications to Slack channels via Incoming Webhooks	`webhook_url`
`discord`	Send updates to Discord servers via webhooks	`webhook_url`
`teams`	Post to Microsoft Teams channels via Adaptive Cards	`webhook_url`
`zapier`	Trigger automated Zapier workflows	`webhook_url`
`generic`	Send to any HTTP endpoint with custom configuration	`url`, `method`

API Endpoints

GET /api/v1/connectors/types

Returns available connector types with required configuration fields.

GET /api/v1/connectors

Returns all connectors for the authenticated user.

POST /api/v1/connectors

Create a new connector.

PATCH /api/v1/connectors/{uuid}

Update an existing connector.

DELETE /api/v1/connectors/{uuid}

Delete a connector.

POST /api/v1/connectors/{uuid}/test

Sends a test notification to verify your connector is working.

Create Examples

{
  "type": "slack",
  "name": "Engineering Channel",
  "config": {
    "webhook_url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXX"
  },
  "events": ["promise.status_changed"],
  "filters": {
    "categories": ["tech-product"]
  }
}

Platform Setup Guides

Slack Setup

Go to your Slack workspace settings
Navigate to Apps > Manage > Custom Integrations
Create an Incoming Webhook
Choose the channel to post to
Copy the webhook URL

Discord Setup

Right-click the channel you want to use
Click Edit Channel > Integrations
Click Webhooks > New Webhook
Copy the webhook URL

Microsoft Teams Setup

In Teams, go to the channel you want
Click ... > Connectors
Search for Incoming Webhook
Configure and copy the webhook URL

Zapier Setup

Create a new Zap in Zapier
Choose Webhooks by Zapier as the trigger
Select Catch Hook
Copy the webhook URL provided
Use this URL in your connector config

Message Formats

Slack

Uses Block Kit for rich formatting with headers, sections, and action buttons.

Discord

Uses Embed objects with colored borders based on promise status.

Microsoft Teams

Uses Adaptive Cards for rich, interactive messages.

Zapier

Receives flattened JSON data for easy use in Zap workflows.

Subscription Limits

Tier	Connectors
Free	0
Pro	5
Journalist	10
Enterprise	Unlimited