Criar regra de automação

curl --request POST \
  --url https://api.jurichat.com/automation-rules/ \
  --header 'Content-Type: application/json' \
  --header 'x-jurichat-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "actions": [
    {
      "actionParams": {
        "targetFunnelColumnId": "<string>"
      }
    }
  ],
  "enabled": false,
  "integrationId": "<string>",
  "conditions": {
    "funnelColumnId": "<string>",
    "fromFunnelColumnId": "<string>",
    "toFunnelColumnId": "<string>",
    "assignedToUserId": "<string>",
    "assignedToDepartmentId": "<string>",
    "messageText": "<string>",
    "templateName": "<string>",
    "restartOnReturn": true
  },
  "elseActions": [
    {
      "actionParams": {
        "targetFunnelColumnId": "<string>"
      }
    }
  ],
  "priority": 0
}
'

import requests

url = "https://api.jurichat.com/automation-rules/"

payload = {
    "name": "<string>",
    "actions": [{ "actionParams": { "targetFunnelColumnId": "<string>" } }],
    "enabled": False,
    "integrationId": "<string>",
    "conditions": {
        "funnelColumnId": "<string>",
        "fromFunnelColumnId": "<string>",
        "toFunnelColumnId": "<string>",
        "assignedToUserId": "<string>",
        "assignedToDepartmentId": "<string>",
        "messageText": "<string>",
        "templateName": "<string>",
        "restartOnReturn": True
    },
    "elseActions": [{ "actionParams": { "targetFunnelColumnId": "<string>" } }],
    "priority": 0
}
headers = {
    "x-jurichat-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-jurichat-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    actions: [{actionParams: {targetFunnelColumnId: '<string>'}}],
    enabled: false,
    integrationId: '<string>',
    conditions: {
      funnelColumnId: '<string>',
      fromFunnelColumnId: '<string>',
      toFunnelColumnId: '<string>',
      assignedToUserId: '<string>',
      assignedToDepartmentId: '<string>',
      messageText: '<string>',
      templateName: '<string>',
      restartOnReturn: true
    },
    elseActions: [{actionParams: {targetFunnelColumnId: '<string>'}}],
    priority: 0
  })
};

fetch('https://api.jurichat.com/automation-rules/', 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://api.jurichat.com/automation-rules/",
  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([
    'name' => '<string>',
    'actions' => [
        [
                'actionParams' => [
                                'targetFunnelColumnId' => '<string>'
                ]
        ]
    ],
    'enabled' => false,
    'integrationId' => '<string>',
    'conditions' => [
        'funnelColumnId' => '<string>',
        'fromFunnelColumnId' => '<string>',
        'toFunnelColumnId' => '<string>',
        'assignedToUserId' => '<string>',
        'assignedToDepartmentId' => '<string>',
        'messageText' => '<string>',
        'templateName' => '<string>',
        'restartOnReturn' => true
    ],
    'elseActions' => [
        [
                'actionParams' => [
                                'targetFunnelColumnId' => '<string>'
                ]
        ]
    ],
    'priority' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-jurichat-api-key: <api-key>"
  ],
]);

$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://api.jurichat.com/automation-rules/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"actions\": [\n    {\n      \"actionParams\": {\n        \"targetFunnelColumnId\": \"<string>\"\n      }\n    }\n  ],\n  \"enabled\": false,\n  \"integrationId\": \"<string>\",\n  \"conditions\": {\n    \"funnelColumnId\": \"<string>\",\n    \"fromFunnelColumnId\": \"<string>\",\n    \"toFunnelColumnId\": \"<string>\",\n    \"assignedToUserId\": \"<string>\",\n    \"assignedToDepartmentId\": \"<string>\",\n    \"messageText\": \"<string>\",\n    \"templateName\": \"<string>\",\n    \"restartOnReturn\": true\n  },\n  \"elseActions\": [\n    {\n      \"actionParams\": {\n        \"targetFunnelColumnId\": \"<string>\"\n      }\n    }\n  ],\n  \"priority\": 0\n}")

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

	req.Header.Add("x-jurichat-api-key", "<api-key>")
	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://api.jurichat.com/automation-rules/")
  .header("x-jurichat-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"actions\": [\n    {\n      \"actionParams\": {\n        \"targetFunnelColumnId\": \"<string>\"\n      }\n    }\n  ],\n  \"enabled\": false,\n  \"integrationId\": \"<string>\",\n  \"conditions\": {\n    \"funnelColumnId\": \"<string>\",\n    \"fromFunnelColumnId\": \"<string>\",\n    \"toFunnelColumnId\": \"<string>\",\n    \"assignedToUserId\": \"<string>\",\n    \"assignedToDepartmentId\": \"<string>\",\n    \"messageText\": \"<string>\",\n    \"templateName\": \"<string>\",\n    \"restartOnReturn\": true\n  },\n  \"elseActions\": [\n    {\n      \"actionParams\": {\n        \"targetFunnelColumnId\": \"<string>\"\n      }\n    }\n  ],\n  \"priority\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jurichat.com/automation-rules/")

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

request = Net::HTTP::Post.new(url)
request["x-jurichat-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"actions\": [\n    {\n      \"actionParams\": {\n        \"targetFunnelColumnId\": \"<string>\"\n      }\n    }\n  ],\n  \"enabled\": false,\n  \"integrationId\": \"<string>\",\n  \"conditions\": {\n    \"funnelColumnId\": \"<string>\",\n    \"fromFunnelColumnId\": \"<string>\",\n    \"toFunnelColumnId\": \"<string>\",\n    \"assignedToUserId\": \"<string>\",\n    \"assignedToDepartmentId\": \"<string>\",\n    \"messageText\": \"<string>\",\n    \"templateName\": \"<string>\",\n    \"restartOnReturn\": true\n  },\n  \"elseActions\": [\n    {\n      \"actionParams\": {\n        \"targetFunnelColumnId\": \"<string>\"\n      }\n    }\n  ],\n  \"priority\": 0\n}"

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

{
  "id": "<string>",
  "officeId": "<string>",
  "integrationId": "<string>",
  "name": "<string>",
  "enabled": true,
  "triggerEvent": "<string>",
  "conditions": {},
  "actions": [
    {
      "action": "<string>",
      "actionParams": {}
    }
  ],
  "elseActions": [
    {
      "action": "<string>",
      "actionParams": {}
    }
  ],
  "priority": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>",
  "statusCode": 123,
  "code": "<string>",
  "details": "<string>"
}

Automation Rules

Criar regra de automação

Cria uma regra que reage a um evento do sistema e executa uma ou mais ações internas em ordem.

Como montar

triggerEvent: pegue o name em GET /webhooks/events — é o mesmo catálogo dos webhooks.
conditions (opcional): filtra o Quando. Sem nenhuma condição efetiva, elseActions é recusado.
actions: de 1 a 5 ações do ramo Então. elseActions: até 5 ações do ramo Senão.
integrationId: null aplica a regra a todas as integrações. Ids em GET /integration.

Parâmetros por ação (actions[].actionParams)

`action`	chave obrigatória	de onde vem o id
`SEND_FAST_MESSAGE`	`fastMessageId` ou `templateName`	`GET /fast-message?inboxId={inboxId}`
`SCHEDULE_MESSAGE`	`text` ou `templateName`	—
`MOVE_CARD`	`targetFunnelColumnId`	`GET /funnel-column`
`TAG_CONVERSATION`	`tagId`	`GET /tag`
`ASSIGN_LEGAL_AREA`	`legalAreaId`	`GET /legal-areas`
`CREATE_TICKET`	`title`	status em `GET /ticket-statuses`
`FIRE_WEBHOOK`	`url` (http/https)	—
`PAUSE_AUTOMATION`	nenhuma	`durationMinutes` opcional; `resumeOnTemplateSent` opcional

Exemplo — enviar uma resposta rápida quando o lead entra numa coluna

{
  "name": "Boas-vindas do funil",
  "enabled": true,
  "triggerEvent": "crm.lead.created",
  "conditions": { "funnelColumnId": "<id de GET /funnel-column>" },
  "actions": [
    {
      "action": "SEND_FAST_MESSAGE",
      "actionParams": { "fastMessageId": "<id de GET /fast-message?inboxId=...>" }
    }
  ]
}

A resposta rápida pode ser TEXT, AUDIO ou SEQUENCE. Numa SEQUENCE, os blocos saem em ordem, no ritmo (typingSeconds / waitSeconds) salvo na própria resposta rápida.

POST

automation-rules

Criar regra de automação

curl --request POST \
  --url https://api.jurichat.com/automation-rules/ \
  --header 'Content-Type: application/json' \
  --header 'x-jurichat-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "actions": [
    {
      "actionParams": {
        "targetFunnelColumnId": "<string>"
      }
    }
  ],
  "enabled": false,
  "integrationId": "<string>",
  "conditions": {
    "funnelColumnId": "<string>",
    "fromFunnelColumnId": "<string>",
    "toFunnelColumnId": "<string>",
    "assignedToUserId": "<string>",
    "assignedToDepartmentId": "<string>",
    "messageText": "<string>",
    "templateName": "<string>",
    "restartOnReturn": true
  },
  "elseActions": [
    {
      "actionParams": {
        "targetFunnelColumnId": "<string>"
      }
    }
  ],
  "priority": 0
}
'

import requests

url = "https://api.jurichat.com/automation-rules/"

payload = {
    "name": "<string>",
    "actions": [{ "actionParams": { "targetFunnelColumnId": "<string>" } }],
    "enabled": False,
    "integrationId": "<string>",
    "conditions": {
        "funnelColumnId": "<string>",
        "fromFunnelColumnId": "<string>",
        "toFunnelColumnId": "<string>",
        "assignedToUserId": "<string>",
        "assignedToDepartmentId": "<string>",
        "messageText": "<string>",
        "templateName": "<string>",
        "restartOnReturn": True
    },
    "elseActions": [{ "actionParams": { "targetFunnelColumnId": "<string>" } }],
    "priority": 0
}
headers = {
    "x-jurichat-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-jurichat-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    actions: [{actionParams: {targetFunnelColumnId: '<string>'}}],
    enabled: false,
    integrationId: '<string>',
    conditions: {
      funnelColumnId: '<string>',
      fromFunnelColumnId: '<string>',
      toFunnelColumnId: '<string>',
      assignedToUserId: '<string>',
      assignedToDepartmentId: '<string>',
      messageText: '<string>',
      templateName: '<string>',
      restartOnReturn: true
    },
    elseActions: [{actionParams: {targetFunnelColumnId: '<string>'}}],
    priority: 0
  })
};

fetch('https://api.jurichat.com/automation-rules/', 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://api.jurichat.com/automation-rules/",
  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([
    'name' => '<string>',
    'actions' => [
        [
                'actionParams' => [
                                'targetFunnelColumnId' => '<string>'
                ]
        ]
    ],
    'enabled' => false,
    'integrationId' => '<string>',
    'conditions' => [
        'funnelColumnId' => '<string>',
        'fromFunnelColumnId' => '<string>',
        'toFunnelColumnId' => '<string>',
        'assignedToUserId' => '<string>',
        'assignedToDepartmentId' => '<string>',
        'messageText' => '<string>',
        'templateName' => '<string>',
        'restartOnReturn' => true
    ],
    'elseActions' => [
        [
                'actionParams' => [
                                'targetFunnelColumnId' => '<string>'
                ]
        ]
    ],
    'priority' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-jurichat-api-key: <api-key>"
  ],
]);

$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://api.jurichat.com/automation-rules/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"actions\": [\n    {\n      \"actionParams\": {\n        \"targetFunnelColumnId\": \"<string>\"\n      }\n    }\n  ],\n  \"enabled\": false,\n  \"integrationId\": \"<string>\",\n  \"conditions\": {\n    \"funnelColumnId\": \"<string>\",\n    \"fromFunnelColumnId\": \"<string>\",\n    \"toFunnelColumnId\": \"<string>\",\n    \"assignedToUserId\": \"<string>\",\n    \"assignedToDepartmentId\": \"<string>\",\n    \"messageText\": \"<string>\",\n    \"templateName\": \"<string>\",\n    \"restartOnReturn\": true\n  },\n  \"elseActions\": [\n    {\n      \"actionParams\": {\n        \"targetFunnelColumnId\": \"<string>\"\n      }\n    }\n  ],\n  \"priority\": 0\n}")

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

	req.Header.Add("x-jurichat-api-key", "<api-key>")
	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://api.jurichat.com/automation-rules/")
  .header("x-jurichat-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"actions\": [\n    {\n      \"actionParams\": {\n        \"targetFunnelColumnId\": \"<string>\"\n      }\n    }\n  ],\n  \"enabled\": false,\n  \"integrationId\": \"<string>\",\n  \"conditions\": {\n    \"funnelColumnId\": \"<string>\",\n    \"fromFunnelColumnId\": \"<string>\",\n    \"toFunnelColumnId\": \"<string>\",\n    \"assignedToUserId\": \"<string>\",\n    \"assignedToDepartmentId\": \"<string>\",\n    \"messageText\": \"<string>\",\n    \"templateName\": \"<string>\",\n    \"restartOnReturn\": true\n  },\n  \"elseActions\": [\n    {\n      \"actionParams\": {\n        \"targetFunnelColumnId\": \"<string>\"\n      }\n    }\n  ],\n  \"priority\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jurichat.com/automation-rules/")

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

request = Net::HTTP::Post.new(url)
request["x-jurichat-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"actions\": [\n    {\n      \"actionParams\": {\n        \"targetFunnelColumnId\": \"<string>\"\n      }\n    }\n  ],\n  \"enabled\": false,\n  \"integrationId\": \"<string>\",\n  \"conditions\": {\n    \"funnelColumnId\": \"<string>\",\n    \"fromFunnelColumnId\": \"<string>\",\n    \"toFunnelColumnId\": \"<string>\",\n    \"assignedToUserId\": \"<string>\",\n    \"assignedToDepartmentId\": \"<string>\",\n    \"messageText\": \"<string>\",\n    \"templateName\": \"<string>\",\n    \"restartOnReturn\": true\n  },\n  \"elseActions\": [\n    {\n      \"actionParams\": {\n        \"targetFunnelColumnId\": \"<string>\"\n      }\n    }\n  ],\n  \"priority\": 0\n}"

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

{
  "id": "<string>",
  "officeId": "<string>",
  "integrationId": "<string>",
  "name": "<string>",
  "enabled": true,
  "triggerEvent": "<string>",
  "conditions": {},
  "actions": [
    {
      "action": "<string>",
      "actionParams": {}
    }
  ],
  "elseActions": [
    {
      "action": "<string>",
      "actionParams": {}
    }
  ],
  "priority": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>",
  "statusCode": 123,
  "code": "<string>",
  "details": "<string>"
}

Authorizations

x-jurichat-api-key

string

header

required

Chave de API do escritório (criada no painel). Envie o valor no header x-jurichat-api-key.

Body

application/json

name

string

required

Nome da regra.

Required string length: 1 - 100

triggerEvent

enum<string>

required

Evento que dispara a automação.

Available options:

crm.lead.created,

crm.lead.updated,

crm.lead.deleted,

crm.lead.moved,

crm.lead.overdue,

chat.conversation.created,

chat.conversation.updated,

chat.conversation.assigned,

chat.message.received,

chat.message.sent,

contact.created,

contact.updated,

contact.deleted,

webhook.test

actions

object[]

required

Ações do ramo Então, executadas quando a condição do Quando é verdadeira.

Required array length: 1 - 5 elements

Show child attributes

enabled

boolean

default:false

Indica se a regra está ativa.

integrationId

string | null

ID da integração. Null para aplicar a todas.

conditions

object | null

Condições que restringem a execução da regra.

Show child attributes

elseActions

object[] | null

Ações do ramo Senão, executadas quando a condição do Quando é falsa.

Maximum array length: 5

Show child attributes

priority

integer

default:0

Prioridade da regra.

Response

Default Response

string

required

officeId

string

required

integrationId

string | null

required

name

string

required

enabled

boolean

required

triggerEvent

string

required

conditions

object | null

required

Show child attributes

actions

object[]

required

Show child attributes

elseActions

object[] | null

required

Show child attributes

priority

number

required

createdAt

string<date-time>

required

updatedAt

string<date-time>

required