POST /conversations/agentOnlinePing

Options

Body

Request body which must comply to the following JSON Schema:

{
  "type" : "object",
  "properties" : {
    "agentId" : {
      "description" : "agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required)."
    },
    "receivedFrom" : {
      "description" : "mark your messages to distinguish messages created by you from the others."
    },
    "agentEmail" : {
      "description" : "agent email. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Brevo organization, a dummy agent will be created automatically."
    },
    "agentName" : {
      "description" : "agent name"
    }
  }
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers