Alterar um webhook

curl

curl -X PATCH 'https://api.synergyconnect.com.br/v1/webhooks/7c1f0c7e-4b53-4c7b-9a51-3f6f0a2d9e10' \
  -H "Authorization: Bearer $SYNERGY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"fields":["messages","statuses","synergy_conversations"]}'

JavaScript

const res = await fetch('https://api.synergyconnect.com.br/v1/webhooks/7c1f0c7e-4b53-4c7b-9a51-3f6f0a2d9e10', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.SYNERGY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "fields": [
      "messages",
      "statuses",
      "synergy_conversations"
    ]
  }),
});
console.log(res.status, await res.json());

Python

import os

import requests

res = requests.patch(
    "https://api.synergyconnect.com.br/v1/webhooks/7c1f0c7e-4b53-4c7b-9a51-3f6f0a2d9e10",
    headers={
        "Authorization": f"Bearer {os.environ['SYNERGY_API_KEY']}",
    },
    json={
        "fields": [
            "messages",
            "statuses",
            "synergy_conversations",
        ],
    },
)
print(res.status_code, res.json())

200

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

400

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

Há 4 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.

404

{
  "error": "Webhook not found"
}

413

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

429

{
  "error": "Rate limit hit"
}