Channels API
The Bird Channels API is an omnichannel messaging solution to allow customers to send and receive messages to multiple different messaging services. This includes SMS, Email and WhatsApp. See supported channels.
To get started with the Channels API you can register for a free account and install your first channels.
Next check out the API reference for sending messages and managing channels
Permissions required for Channel actions
To manage channels, create channel connectors or send messages via the API the access key that is being used needs a certain level of permissions to carry out these actions.
The examples below give your access key permissions to all channels in all of your workspaces but you replace the wildcards with either specific workspace or channel ids to limit the scope further
Replace any instance of {organizationId} with your Bird organization id
Channel Viewer
An example of the resource permissions that are required to view a list of all channels, specific channels, channel messages, webhooks and uploaded media create an access policy that allows view as follows:
| Action | Resource |
|---|---|
| List all channels | /workspaces/*/channels |
| Get a specific channel | /workspaces/*/channels/* |
| Get all messages for a channel | /workspaces/*/channels/*/messages |
| Get a specific message for a channel | /workspaces/*/channels/*/messages/* |
| Get all interactions that have happened to a message | /workspaces/*/channels/*/messages/*/interactions |
| Get outgoing media to channels | /workspaces/*/channels/*/media/* |
| Get media attached to incoming messages | /workspaces/*/messages/*/media/* |
| List webhook subscriptions | /organizations/{organizationId}/workspaces/*/webhook-subscriptions |
| Get a specific webhook subscription | /organizations/{organizationId}/workspaces/*/webhook-subscriptions/* |
| List available webhook events | /organizations/{organizationId}/workspaces/*/webhook-subscriptions |
| Get webhook subscription logs | /organizations/{organizationId}/workspaces/*/webhook-subscriptions/*/logs |
| Get webhook log details by request id | /organizations/{organizationId}/workspaces/*/webhook-subscriptions/*/logs/details |
Message sending and status updates
To send messages to a channel and subscribe to status update create an access policy that allows create as follows:
| Action | Resource |
|---|---|
| Create a new message | /workspaces/*/channels/*/messages |
| Upload media | /workspaces/*/channels/*/presigned-upload |
| Create a webhook subscription | /organizations/{organizationId}/workspaces/*/webhook-subscriptions |
Updating channel settings and webhook subscriptions
To update settings for a channel or update a webhook subscription create an access policy that allows update as follows:
| Action | Resource |
|---|---|
| Update channel settings | /workspaces/*/channels/* |
| Update a webhook subscription | /organizations/{organizationId}/workspaces/*/webhook-subscriptions/* |
Delete a webhook subscription
To delete a webhook subscription reate an access policy that allows delete as follows:
| Action | Resource |
|---|---|
| Delete a webhook subscription | organizations/{organizationId}/workspaces/*/webhook-subscriptions/* |
Connector installation
Channels are created by first installing a new connector. Connectors are responsible for linking the Bird platform to third party platforms. To create a connector create an access policy that allows create as follows:
| Action | Resource |
|---|---|
| Create a new connector | /workspaces/*/connectors |
Connector viewer
To view connectors that are installed in a workspace and check the health of the connectors create an access policy that allow view as follows:
| Action | Resource |
|---|---|
| List all connectors | /workspaces/*/connectors |
| Get a specific connector | /workspaces/*/connectors/* |
| Get connector health | /workspaces/*/connectors/*/status |