Integrations

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

Request

  • Base URL: https://api.notifly.io
  • URL: https://api.notifly.io/v1/integrations/channel-endpoints/link
  • Auth: API key in header Authorization

Request body

integrationIdentifierstring required

Integration identifier for the chat provider integration

subscriberIdstring required

External subscriber identifier to link to their chat identity

contextobject
contextHashstring

HMAC-SHA256 of the canonicalized context, signed with the tenant environment secret key (the same "Inbox with context" signing scheme). Required when the integration has HMAC validation enabled.

Example request

{
  "integrationIdentifier": "telegram-bot",
  "subscriberId": "subscriber-123",
  "contextHash": "a1b2c3d4e5f6..."
}

Response

OK

Example response

{
  "data": {
    "url": "https://t.me/MyBot?start=AbCdEfGhIjKlMnOpQrStUvWxYz012345",
    "providerMetadata": {
      "botUsername": "MyBot",
      "expiresAt": "2026-06-23T12:00:00.000Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.