Criar webhook

Cria um webhook ativo que envia os eventos de post escolhidos para o seu endpoint. A resposta traz o signing_secret. O endpoint precisa ser uma URL pública http ou https: outros esquemas e endereços privados ou locais são recusados com 422 em endpoint (mensagem Este endpoint não é permitido.; as mensagens seguem o idioma do servidor, português no PostClean).

Cada entrega é um POST em JSON com o corpo {id, type, data, created_at} e o cabeçalho X-Webhook-Signature: o HMAC-SHA256 em hexadecimal do corpo bruto, com o signing_secret do webhook como chave. Calcule o seu próprio HMAC do corpo e compare antes de confiar na entrega. Uma entrega que não recebe resposta 2xx em 10 segundos é tentada mais duas vezes, com um minuto de intervalo. Redirecionamentos não são seguidos.

POST /webhooks

Criar webhook

cURL

curl --request POST \
  --url https://post.chatclean.com.br/api/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endpoint": "https://example.com/hooks/postclean",
  "events": [
    "post.published",
    "post.failed"
  ]
}
'

201

{
  "id": "9b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
  "endpoint": "https://example.com/hooks/postclean",
  "events": [
    "post.published",
    "post.failed"
  ],
  "status": "enabled",
  "last_sent_at": null,
  "paused_at": null,
  "consecutive_failures": 0,
  "signing_secret": "whsec_4qXbV8kP2mT7nR1sW9yZ3cE6hJ0aL5dF",
  "created_at": "2026-09-15T10:00:00+00:00",
  "updated_at": "2026-10-08T14:00:03+00:00"
}

Authorizations

Authorization · string · header · required

Chave de API do workspace, criada em Configurações > Chaves de API.

Body

application/json

endpoint · string<uri> · required

Maximum string length: 255

events · enum<string>[] · required

Minimum array length: 1

• post.created: um post foi criado. O data.status é o status com que ele foi criado (draft, scheduled, publishing ou pending_approval).
• post.scheduled: um post existente foi agendado (por exemplo, um rascunho agendado ou uma solicitação aprovada). Um post criado já agendado envia só post.created.
• post.unscheduled: um post agendado voltou para rascunho ou para aguardando aprovação.
• post.published: o post foi publicado em todos os canais.
• post.partially_published: o post foi publicado em alguns canais e falhou em outros.
• post.failed: a publicação falhou.
• post.deleted: um post foi excluído. Não é enviado para posts importados da rede nem para posts removidos ao desconectar o canal deles. O data é só {id, workspace_id}.

Available options: post.created, post.scheduled, post.unscheduled, post.published, post.partially_published, post.failed, post.deleted

Response

201

application/json

O webhook criado, com o segredo de assinatura.

id · string<uuid>

endpoint · string<uri>

events · enum<string>[]

• post.created: um post foi criado. O data.status é o status com que ele foi criado (draft, scheduled, publishing ou pending_approval).
• post.scheduled: um post existente foi agendado (por exemplo, um rascunho agendado ou uma solicitação aprovada). Um post criado já agendado envia só post.created.
• post.unscheduled: um post agendado voltou para rascunho ou para aguardando aprovação.
• post.published: o post foi publicado em todos os canais.
• post.partially_published: o post foi publicado em alguns canais e falhou em outros.
• post.failed: a publicação falhou.
• post.deleted: um post foi excluído. Não é enviado para posts importados da rede nem para posts removidos ao desconectar o canal deles. O data é só {id, workspace_id}.

Available options: post.created, post.scheduled, post.unscheduled, post.published, post.partially_published, post.failed, post.deleted

status · enum<string>

O PostClean define paused depois de 5 entregas seguidas com falha (o dono da conta recebe um e-mail). Envie status: enabled para retomar.

Available options: enabled, disabled, paused

last_sent_at · string<date-time> | null

ISO 8601, em UTC.

Example:

"2026-10-08T14:00:03+00:00"

paused_at · string<date-time> | null

ISO 8601, em UTC.

consecutive_failures · integer

signing_secret · string

Segredo usado para assinar as entregas (whsec_ seguido de 32 caracteres). Só vem ao criar, obter ou trocar o segredo do webhook.

Example:

"whsec_4qXbV8kP2mT7nR1sW9yZ3cE6hJ0aL5dF"

created_at · string<date-time>

ISO 8601, em UTC.

Example:

"2026-09-15T10:00:00+00:00"

updated_at · string<date-time>

ISO 8601, em UTC.

Example:

"2026-10-08T14:00:03+00:00"