Criar um webhook

curl

curl -X POST 'https://api.synergyconnect.com.br/v1/webhooks' \
  -H "Authorization: Bearer $SYNERGY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://hooks.example.com/synergy","fields":["messages","statuses"],"instanceIds":null,"headers":{"Authorization":"Bearer meu-token"}}'

JavaScript

const res = await fetch('https://api.synergyconnect.com.br/v1/webhooks', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SYNERGY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "url": "https://hooks.example.com/synergy",
    "fields": [
      "messages",
      "statuses"
    ],
    "instanceIds": null,
    "headers": {
      "Authorization": "Bearer meu-token"
    }
  }),
});
console.log(res.status, await res.json());

Python

import os

import requests

res = requests.post(
    "https://api.synergyconnect.com.br/v1/webhooks",
    headers={
        "Authorization": f"Bearer {os.environ['SYNERGY_API_KEY']}",
    },
    json={
        "url": "https://hooks.example.com/synergy",
        "fields": [
            "messages",
            "statuses",
        ],
        "instanceIds": None,
        "headers": {
            "Authorization": "Bearer meu-token",
        },
    },
)
print(res.status_code, res.json())

201

{
  "row": {
    "id": "7c1f0c7e-4b53-4c7b-9a51-3f6f0a2d9e10",
    "url": "https://hooks.example.com/synergy",
    "fields": [
      "messages",
      "statuses"
    ],
    "statuses": null,
    "instanceIds": null,
    "enabled": true,
    "verification": "ping",
    "headerNames": [
      "Authorization"
    ],
    "disabledReason": null,
    "createdBy": "key:0b9c4d1e-52a7-4f6b-8c3d-1e2f3a4b5c6d",
    "createdAt": 1767225600000,
    "updatedAt": 1767225600000,
    "name": null
  },
  "secret": "9f2c4e6a8b0d1f3a5c7e9b1d3f5a7c9e",
  "pending": 0
}

400

{
  "error": "Invalid body",
  "issues": [
    {
      "code": "invalid_type",
      "expected": "array",
      "path": [
        "fields"
      ],
      "message": "Invalid input: expected array, received undefined"
    }
  ]
}

Há 5 casos com este status; veja a tabela de respostas.

401

{
  "error": "Invalid or revoked key"
}

Há 2 casos com este status; veja a tabela de respostas.

403

{
  "error": "This key lacks the management scope"
}

Há 3 casos com este status; veja a tabela de respostas.

413

{
  "error": "The body is too large (16 KB max)"
}

429

{
  "error": "Rate limit hit"
}