POST /conversations/pushedMessages
Send an automated (pushed) message to a visitor on behalf of an agent. Example use cases: order status updates, announcing new features in your web app, etc.
Servers
- https://api.brevo.com/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
groupId |
String | No |
Group ID. It can be found on the group's page. |
text |
String | Yes |
Message text. |
agentId |
String | No |
Agent ID. It can be found on the agent's page or received from a webhook. |
visitorId |
String | Yes |
Visitor's ID received from a webhook or generated by you to bind an existing user account to Conversations. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.