Notifly
API ReferenceIntegrations

Issue a URL to link a subscriber chat identity

Returns a provider-specific URL the subscriber opens to link their chat identity. The integration provider is resolved from integrationIdentifier; Telegram returns a deep link.

POST
/v1/integrations/channel-endpoints/link

Returns a provider-specific URL the subscriber opens to link their chat identity. The integration provider is resolved from integrationIdentifier; Telegram returns a deep link.

Authorization

secretKey
Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <secret_key>".

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/integrations/channel-endpoints/link" \  -H "Content-Type: application/json" \  -d '{    "integrationIdentifier": "telegram-bot",    "subscriberId": "subscriber-123"  }'
{  "data": {    "url": "https://t.me/MyBot?start=AbCdEfGhIjKlMnOpQrStUvWxYz012345",    "providerMetadata": {      "botUsername": "MyBot",      "expiresAt": "2026-06-23T12:00:00.000Z"    }  }}

Generate OAuth URL to link a subscriber user identity POST

Generate an OAuth URL that links a specific subscriber to their chat identity (Slack user ID or MS Teams user OID). The generated URL expires after 5 minutes.

Configure a chat integration webhook POST

Registers the Notifly webhook URL with the chat provider for the specified integration. Telegram is the only supported provider initially.