Webhook - Decide which agent receives the conversation

curl --request POST \
  --url https://yourdomain.com/webhooks/on-agent-assignation \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_id": 1234,
  "survey_user_id": 567890,
  "contact": {
    "treble_id": "5215512345678",
    "name": "Andrea Soto",
    "country_code": "52",
    "cellphone": "5512345678",
    "business_scope_id": "1029384756",
    "username": null
  },
  "crm_type": "salesforce",
  "crm_objects": [
    {
      "entity": "Contact",
      "id": "0035f00000ABCDEqAO"
    },
    {
      "entity": "Account",
      "id": "0015f00000FGHIJqAO"
    }
  ],
  "channel": {
    "phone_number_id": "1234567890"
  },
  "metadata": {
    "poll_id": 4321,
    "node_id": "a1b2c3",
    "tag": "Comercial",
    "language": "es"
  }
}
'

import requests

url = "https://yourdomain.com/webhooks/on-agent-assignation"

payload = {
    "company_id": 1234,
    "survey_user_id": 567890,
    "contact": {
        "treble_id": "5215512345678",
        "name": "Andrea Soto",
        "country_code": "52",
        "cellphone": "5512345678",
        "business_scope_id": "1029384756",
        "username": None
    },
    "crm_type": "salesforce",
    "crm_objects": [
        {
            "entity": "Contact",
            "id": "0035f00000ABCDEqAO"
        },
        {
            "entity": "Account",
            "id": "0015f00000FGHIJqAO"
        }
    ],
    "channel": { "phone_number_id": "1234567890" },
    "metadata": {
        "poll_id": 4321,
        "node_id": "a1b2c3",
        "tag": "Comercial",
        "language": "es"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    company_id: 1234,
    survey_user_id: 567890,
    contact: {
      treble_id: '5215512345678',
      name: 'Andrea Soto',
      country_code: '52',
      cellphone: '5512345678',
      business_scope_id: '1029384756',
      username: null
    },
    crm_type: 'salesforce',
    crm_objects: [
      {entity: 'Contact', id: '0035f00000ABCDEqAO'},
      {entity: 'Account', id: '0015f00000FGHIJqAO'}
    ],
    channel: {phone_number_id: '1234567890'},
    metadata: {poll_id: 4321, node_id: 'a1b2c3', tag: 'Comercial', language: 'es'}
  })
};

fetch('https://yourdomain.com/webhooks/on-agent-assignation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://yourdomain.com/webhooks/on-agent-assignation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'company_id' => 1234,
    'survey_user_id' => 567890,
    'contact' => [
        'treble_id' => '5215512345678',
        'name' => 'Andrea Soto',
        'country_code' => '52',
        'cellphone' => '5512345678',
        'business_scope_id' => '1029384756',
        'username' => null
    ],
    'crm_type' => 'salesforce',
    'crm_objects' => [
        [
                'entity' => 'Contact',
                'id' => '0035f00000ABCDEqAO'
        ],
        [
                'entity' => 'Account',
                'id' => '0015f00000FGHIJqAO'
        ]
    ],
    'channel' => [
        'phone_number_id' => '1234567890'
    ],
    'metadata' => [
        'poll_id' => 4321,
        'node_id' => 'a1b2c3',
        'tag' => 'Comercial',
        'language' => 'es'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://yourdomain.com/webhooks/on-agent-assignation"

	payload := strings.NewReader("{\n  \"company_id\": 1234,\n  \"survey_user_id\": 567890,\n  \"contact\": {\n    \"treble_id\": \"5215512345678\",\n    \"name\": \"Andrea Soto\",\n    \"country_code\": \"52\",\n    \"cellphone\": \"5512345678\",\n    \"business_scope_id\": \"1029384756\",\n    \"username\": null\n  },\n  \"crm_type\": \"salesforce\",\n  \"crm_objects\": [\n    {\n      \"entity\": \"Contact\",\n      \"id\": \"0035f00000ABCDEqAO\"\n    },\n    {\n      \"entity\": \"Account\",\n      \"id\": \"0015f00000FGHIJqAO\"\n    }\n  ],\n  \"channel\": {\n    \"phone_number_id\": \"1234567890\"\n  },\n  \"metadata\": {\n    \"poll_id\": 4321,\n    \"node_id\": \"a1b2c3\",\n    \"tag\": \"Comercial\",\n    \"language\": \"es\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://yourdomain.com/webhooks/on-agent-assignation")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_id\": 1234,\n  \"survey_user_id\": 567890,\n  \"contact\": {\n    \"treble_id\": \"5215512345678\",\n    \"name\": \"Andrea Soto\",\n    \"country_code\": \"52\",\n    \"cellphone\": \"5512345678\",\n    \"business_scope_id\": \"1029384756\",\n    \"username\": null\n  },\n  \"crm_type\": \"salesforce\",\n  \"crm_objects\": [\n    {\n      \"entity\": \"Contact\",\n      \"id\": \"0035f00000ABCDEqAO\"\n    },\n    {\n      \"entity\": \"Account\",\n      \"id\": \"0015f00000FGHIJqAO\"\n    }\n  ],\n  \"channel\": {\n    \"phone_number_id\": \"1234567890\"\n  },\n  \"metadata\": {\n    \"poll_id\": 4321,\n    \"node_id\": \"a1b2c3\",\n    \"tag\": \"Comercial\",\n    \"language\": \"es\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://yourdomain.com/webhooks/on-agent-assignation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_id\": 1234,\n  \"survey_user_id\": 567890,\n  \"contact\": {\n    \"treble_id\": \"5215512345678\",\n    \"name\": \"Andrea Soto\",\n    \"country_code\": \"52\",\n    \"cellphone\": \"5512345678\",\n    \"business_scope_id\": \"1029384756\",\n    \"username\": null\n  },\n  \"crm_type\": \"salesforce\",\n  \"crm_objects\": [\n    {\n      \"entity\": \"Contact\",\n      \"id\": \"0035f00000ABCDEqAO\"\n    },\n    {\n      \"entity\": \"Account\",\n      \"id\": \"0015f00000FGHIJqAO\"\n    }\n  ],\n  \"channel\": {\n    \"phone_number_id\": \"1234567890\"\n  },\n  \"metadata\": {\n    \"poll_id\": 4321,\n    \"node_id\": \"a1b2c3\",\n    \"tag\": \"Comercial\",\n    \"language\": \"es\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "agent_email": "andrea.soto@yourcompany.com"
}

API Assignment

Assignment webhook reference

This endpoint must be implemented on YOUR server (for example: https://yourdomain.com/webhooks/on-agent-assignation). Treble will call it when a conversation reaches a Transfer Methods block configured with the API destination, so your system can decide which agent should receive the chat.

The URL is configured in the block itself, inside the conversation editor. If you enable Token / API Key authentication, Treble will include your token in the Authorization header with the format Bearer YOUR_TOKEN.

You must respond in less than 10 seconds. If your server doesn’t respond in time, returns a status code other than 200, or returns an agent that can’t receive the conversation, Treble will apply the fallback method configured in the main platform.

POST

webhooks

on-agent-assignation

Webhook - Decide which agent receives the conversation

curl --request POST \
  --url https://yourdomain.com/webhooks/on-agent-assignation \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_id": 1234,
  "survey_user_id": 567890,
  "contact": {
    "treble_id": "5215512345678",
    "name": "Andrea Soto",
    "country_code": "52",
    "cellphone": "5512345678",
    "business_scope_id": "1029384756",
    "username": null
  },
  "crm_type": "salesforce",
  "crm_objects": [
    {
      "entity": "Contact",
      "id": "0035f00000ABCDEqAO"
    },
    {
      "entity": "Account",
      "id": "0015f00000FGHIJqAO"
    }
  ],
  "channel": {
    "phone_number_id": "1234567890"
  },
  "metadata": {
    "poll_id": 4321,
    "node_id": "a1b2c3",
    "tag": "Comercial",
    "language": "es"
  }
}
'

import requests

url = "https://yourdomain.com/webhooks/on-agent-assignation"

payload = {
    "company_id": 1234,
    "survey_user_id": 567890,
    "contact": {
        "treble_id": "5215512345678",
        "name": "Andrea Soto",
        "country_code": "52",
        "cellphone": "5512345678",
        "business_scope_id": "1029384756",
        "username": None
    },
    "crm_type": "salesforce",
    "crm_objects": [
        {
            "entity": "Contact",
            "id": "0035f00000ABCDEqAO"
        },
        {
            "entity": "Account",
            "id": "0015f00000FGHIJqAO"
        }
    ],
    "channel": { "phone_number_id": "1234567890" },
    "metadata": {
        "poll_id": 4321,
        "node_id": "a1b2c3",
        "tag": "Comercial",
        "language": "es"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    company_id: 1234,
    survey_user_id: 567890,
    contact: {
      treble_id: '5215512345678',
      name: 'Andrea Soto',
      country_code: '52',
      cellphone: '5512345678',
      business_scope_id: '1029384756',
      username: null
    },
    crm_type: 'salesforce',
    crm_objects: [
      {entity: 'Contact', id: '0035f00000ABCDEqAO'},
      {entity: 'Account', id: '0015f00000FGHIJqAO'}
    ],
    channel: {phone_number_id: '1234567890'},
    metadata: {poll_id: 4321, node_id: 'a1b2c3', tag: 'Comercial', language: 'es'}
  })
};

fetch('https://yourdomain.com/webhooks/on-agent-assignation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://yourdomain.com/webhooks/on-agent-assignation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'company_id' => 1234,
    'survey_user_id' => 567890,
    'contact' => [
        'treble_id' => '5215512345678',
        'name' => 'Andrea Soto',
        'country_code' => '52',
        'cellphone' => '5512345678',
        'business_scope_id' => '1029384756',
        'username' => null
    ],
    'crm_type' => 'salesforce',
    'crm_objects' => [
        [
                'entity' => 'Contact',
                'id' => '0035f00000ABCDEqAO'
        ],
        [
                'entity' => 'Account',
                'id' => '0015f00000FGHIJqAO'
        ]
    ],
    'channel' => [
        'phone_number_id' => '1234567890'
    ],
    'metadata' => [
        'poll_id' => 4321,
        'node_id' => 'a1b2c3',
        'tag' => 'Comercial',
        'language' => 'es'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://yourdomain.com/webhooks/on-agent-assignation"

	payload := strings.NewReader("{\n  \"company_id\": 1234,\n  \"survey_user_id\": 567890,\n  \"contact\": {\n    \"treble_id\": \"5215512345678\",\n    \"name\": \"Andrea Soto\",\n    \"country_code\": \"52\",\n    \"cellphone\": \"5512345678\",\n    \"business_scope_id\": \"1029384756\",\n    \"username\": null\n  },\n  \"crm_type\": \"salesforce\",\n  \"crm_objects\": [\n    {\n      \"entity\": \"Contact\",\n      \"id\": \"0035f00000ABCDEqAO\"\n    },\n    {\n      \"entity\": \"Account\",\n      \"id\": \"0015f00000FGHIJqAO\"\n    }\n  ],\n  \"channel\": {\n    \"phone_number_id\": \"1234567890\"\n  },\n  \"metadata\": {\n    \"poll_id\": 4321,\n    \"node_id\": \"a1b2c3\",\n    \"tag\": \"Comercial\",\n    \"language\": \"es\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://yourdomain.com/webhooks/on-agent-assignation")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_id\": 1234,\n  \"survey_user_id\": 567890,\n  \"contact\": {\n    \"treble_id\": \"5215512345678\",\n    \"name\": \"Andrea Soto\",\n    \"country_code\": \"52\",\n    \"cellphone\": \"5512345678\",\n    \"business_scope_id\": \"1029384756\",\n    \"username\": null\n  },\n  \"crm_type\": \"salesforce\",\n  \"crm_objects\": [\n    {\n      \"entity\": \"Contact\",\n      \"id\": \"0035f00000ABCDEqAO\"\n    },\n    {\n      \"entity\": \"Account\",\n      \"id\": \"0015f00000FGHIJqAO\"\n    }\n  ],\n  \"channel\": {\n    \"phone_number_id\": \"1234567890\"\n  },\n  \"metadata\": {\n    \"poll_id\": 4321,\n    \"node_id\": \"a1b2c3\",\n    \"tag\": \"Comercial\",\n    \"language\": \"es\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://yourdomain.com/webhooks/on-agent-assignation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_id\": 1234,\n  \"survey_user_id\": 567890,\n  \"contact\": {\n    \"treble_id\": \"5215512345678\",\n    \"name\": \"Andrea Soto\",\n    \"country_code\": \"52\",\n    \"cellphone\": \"5512345678\",\n    \"business_scope_id\": \"1029384756\",\n    \"username\": null\n  },\n  \"crm_type\": \"salesforce\",\n  \"crm_objects\": [\n    {\n      \"entity\": \"Contact\",\n      \"id\": \"0035f00000ABCDEqAO\"\n    },\n    {\n      \"entity\": \"Account\",\n      \"id\": \"0015f00000FGHIJqAO\"\n    }\n  ],\n  \"channel\": {\n    \"phone_number_id\": \"1234567890\"\n  },\n  \"metadata\": {\n    \"poll_id\": 4321,\n    \"node_id\": \"a1b2c3\",\n    \"tag\": \"Comercial\",\n    \"language\": \"es\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "agent_email": "andrea.soto@yourcompany.com"
}

Headers

Authorization

string

Only if you configured Token / API Key authentication in the block. Treble sends the token with the format Bearer YOUR_TOKEN.

Body

application/json

Context of the contact and the conversation that Treble sends to your endpoint

Body Treble sends to your endpoint so you can decide which agent receives the conversation.

company_id

integer

Your company's identifier in Treble.

Example:

1234

survey_user_id

integer

Identifier of the contact's session in the conversation.

Example:

567890

contact

object

Information about the contact in the conversation.

Show child attributes

crm_type

string | null

The CRM your account is integrated with, for example salesforce or hubspot. It's null if the account has no CRM integration.

Example:

"salesforce"

crm_objects

object[]

CRM records associated with the contact. An empty array means the contact isn't associated with any record yet.

Show child attributes

channel

object

Channel the conversation came in through.

Show child attributes

metadata

object

Context of the flow and the block that originated the call.

Show child attributes

Response

200 - application/json

The agent Treble must assign the conversation to. Return agent_email (recommended) or agent_id.

Response your server must return indicating the agent who will receive the conversation. Use agent_email or agent_id.

agent_email

string

The agent's email as registered in Treble. It's the recommended option because it doesn't depend on Treble's internal identifiers.

Example:

"andrea.soto@yourcompany.com"

agent_id

integer

The agent's identifier in Treble.

Example:

4567

Agent assignment webhook Multimedia Variable

⌘I

Introduction to API

API

Webhooks

Editor

Guides and Tutorials

Assignment webhook reference

Headers

Body

Response