Pular para o conteúdo principal
PATCH
/
api
/
v1
/
accounts
/
{account_id}
/
webhooks
/
{webhook_id}
Atualizar a webhook object
curl --request PATCH \
  --url https://airys.chat/api/v1/accounts/{account_id}/webhooks/{webhook_id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "url": "https://example.com/webhook",
  "name": "<string>",
  "subscriptions": [
    "conversation_created",
    "conversation_status_changed"
  ]
}
'
import requests

url = "https://airys.chat/api/v1/accounts/{account_id}/webhooks/{webhook_id}"

payload = {
    "url": "https://example.com/webhook",
    "name": "<string>",
    "subscriptions": ["conversation_created", "conversation_status_changed"]
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com/webhook',
    name: '<string>',
    subscriptions: ['conversation_created', 'conversation_status_changed']
  })
};

fetch('https://airys.chat/api/v1/accounts/{account_id}/webhooks/{webhook_id}', 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://airys.chat/api/v1/accounts/{account_id}/webhooks/{webhook_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com/webhook',
    'name' => '<string>',
    'subscriptions' => [
        'conversation_created',
        'conversation_status_changed'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_access_token: <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://airys.chat/api/v1/accounts/{account_id}/webhooks/{webhook_id}"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/webhook\",\n  \"name\": \"<string>\",\n  \"subscriptions\": [\n    \"conversation_created\",\n    \"conversation_status_changed\"\n  ]\n}")

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

	req.Header.Add("api_access_token", "<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.patch("https://airys.chat/api/v1/accounts/{account_id}/webhooks/{webhook_id}")
  .header("api_access_token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/webhook\",\n  \"name\": \"<string>\",\n  \"subscriptions\": [\n    \"conversation_created\",\n    \"conversation_status_changed\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://airys.chat/api/v1/accounts/{account_id}/webhooks/{webhook_id}")

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

request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/webhook\",\n  \"name\": \"<string>\",\n  \"subscriptions\": [\n    \"conversation_created\",\n    \"conversation_status_changed\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "url": "<string>",
  "name": "<string>",
  "subscriptions": [],
  "account_id": 123
}
{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Autorizações

​
api_access_token
string
header
obrigatório

Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

​
account_id
integer
obrigatório

O ID numérico da conta

​
webhook_id
integer
obrigatório

O ID numérico do webhook

Corpo

application/json
​
url
string

A url para onde os eventos devem ser enviados

Exemplo:

"https://example.com/webhook"

​
name
string

O nome do webhook

​
subscriptions
enum<string>[]

Os eventos que você deseja assinar.

Opções disponíveis:
conversation_created,
conversation_status_changed,
conversation_updated,
message_created,
message_updated,
contact_created,
contact_updated,
webwidget_triggered
Exemplo:
[
  "conversation_created",
  "conversation_status_changed"
]

Resposta

Sucesso

​
id
number

O ID do webhook

​
url
string

O URL para o qual os eventos serão enviados

​
name
string

O nome do webhook

​
subscriptions
enum<string>[]

A lista de eventos inscritos

Opções disponíveis:
conversation_created,
conversation_status_changed,
conversation_updated,
contact_created,
contact_updated,
message_created,
message_updated,
webwidget_triggered
​
account_id
number

O id da conta ao qual o objeto webhook pertence