Channels
Channels API allows you to integrate your existing messaging channels into Pipedrive through Messaging app extension. It enables you to manage and interact with the channel’s conversations, participants and messages inside Pipedrive Messaging inbox: get the historical conversation, receive and send new messages. These endpoints are accessible only through Messengers integration OAuth scope together with Messaging manifest in building the Messaging app extension.
Add a channel
Adds a new messaging channel, only admins are able to register new channels. It will use the getConversations endpoint to fetch conversations, participants and messages afterward. To use the endpoint, you need to have Messengers integration OAuth scope enabled and the Messaging manifest ready for the Messaging app extension.
Request
/v1/channels
Body parameters
application/json
name
string
required
The name of the channel
provider_channel_id
string
required
The channel ID
avatar_url
string
The URL for an icon that represents your channel
Format
url
template_support
boolean
If true, enables templates logic on UI. Requires getTemplates endpoint implemented. Find out more here.
provider_type
string
It controls the icons (like the icon next to the conversation)
Default
other
Values
other
Response
OK
Expand all
Copy code- true
- { ... }▶
Receives an incoming message
Adds a message to a conversation. To use the endpoint, you need to have Messengers integration OAuth scope enabled and the Messaging manifest ready for the Messaging app extension.
Request
/v1/channels/messages/receive
Body parameters
application/json
id
string
required
The ID of the message
channel_id
string
required
The channel ID as in the provider
sender_id
string
required
The ID of the provider's user that sent the message
conversation_id
string
required
The ID of the conversation
message
string
required
The body of the message
status
string
required
The status of the message
Values
sent
delivered
read
failed
created_at
string
required
The date and time when the message was created in the provider, in UTC. Format: YYYY-MM-DD HH:MM
Format
date-time
reply_by
string
The date and time when the message can no longer receive a reply, in UTC. Format: YYYY-MM-DD HH:MM
Format
date-time
conversation_link
string
A URL that can open the conversation in the provider's side
Format
url
attachments
array
The list of attachments available in the message
Response
OK
Expand allCopy code- true
- { ... }▶
Delete a channel
Deletes an existing messenger’s channel and all related entities (conversations and messages). To use the endpoint, you need to have Messengers integration OAuth scope enabled and the Messaging manifest ready for the Messaging app extension.
Request
/v1/channels/{id}
Path parameters
id
string
required
The ID of the channel provided by the integration
Response
OK
Expand allCopy code- true
Delete a conversation
Deletes an existing conversation. To use the endpoint, you need to have Messengers integration OAuth scope enabled and the Messaging manifest ready for the Messaging app extension.
Request
/v1/channels/{channel-id}/conversations/{conversation-id}
Path parameters
channel-id
string
required
The ID of the channel provided by the integration
conversation-id
string
required
The ID of the conversation provided by the integration
Response
OK
Expand allCopy code- true