POST /webhooks

Listar/cadastrar destino e assinaturas de eventos. Contrato v1 · disponível em produção e homologação · operação createWebhooks. Guia funcional · Índice · Schemas · Testar em sandbox.

Autenticação e efeito

Permissão: webhooks:create. Sessão humana ou chave de servidor limitada ao proprietário e aos aplicativos autorizados. OAuth/MCP ainda não estão disponíveis. Uma chave de exemplo deve incluir somente esta permissão e as leituras necessárias ao seu fluxo, restrita a app_loja; emita-a na área autenticada de desenvolvedores.

Disponível em produção e homologação; sujeito às capacidades do app e à configuração do provedor. OAuth só será aceito após B1b. Campos desconhecidos rejeitados. Consulte os ADRs para regras semânticas além do JSON Schema.

O efeito é autenticado, auditado e pode gerar publicação eventual e eventos do recurso. Links/domínios/templates podem precisar de propagação antes de aparecerem publicamente. Não muda identidade de link implicitamente. Dependências e capabilities podem bloquear a ação. O status confirma a persistência descrita, sem prometer propagação global imediata.

Parâmetros

Nome	Local	Obrigatório	Tipo e restrições
Idempotency-Key	header	sim	UUID v4 por intenção. Recibo por 24h. Mudança de payload/precondição retorna 409. Segredo de chave não é reexibido. IdempotencyKey; {“type”:“string”,“maxLength”:36,“pattern”:“^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$”}

Corpo e semântica

Content-Type: application/json. Campos desconhecidos são rejeitados no envelope.

Campo	Tipo	Obrigatório	Significado e limites
appId	AppId	sim	Aplicativo proprietário; precisa estar autorizado.
name	string	sim	Nome de exibição. Até 100 caracteres; Formato validado pelo schema
url	string	sim	Endereço do recurso; não acrescente credenciais. Até 2048 caracteres; uri; Formato validado pelo schema
events	array	sim	Valor tipado; formato e restrições completos no schema abaixo. Até 9 itens

Omitir campos opcionais usa o default documentado ou preserva o valor em PATCH. null só é aceito nos campos cujo schema permite null, com efeito de limpar/desvincular indicado no guia. Arrays enviados substituem a coleção quando o endpoint define atualização completa; não implicam merge. Identificadores/owner/app de um recurso existente não são transferidos por PATCH. Herança de templates/UTMs segue o guia, sem alterar links anteriores por cópia automática.

Request mínimo

{
  "appId": "app_loja",
  "name": "Integração",
  "url": "https://hooks.example.com/agilink",
  "events": [
    "link.created"
  ]
}

Request completo de referência

{
  "appId": "app_loja",
  "name": "Integração",
  "url": "https://hooks.example.com/agilink",
  "events": [
    "link.created"
  ]
}

cURL

AGILINK_API_KEY deve ficar no servidor. Os placeholders abaixo são fictícios. Preserve Idempotency-Key e payload ao repetir uma intenção após timeout.

curl --request POST 'https://api.staging.agilink.io/v1/webhooks' \
  --header 'Authorization: Bearer <credencial>' \
  --header 'Idempotency-Key: 10000000-0000-4000-8000-000000000001' \
  --header 'Content-Type: application/json' \
  --data '{"appId":"app_loja","name":"Integração","url":"https://hooks.example.com/agilink","events":["link.created"]}'

JavaScript / TypeScript

// Node.js 22+. Defina AGILINK_API_KEY no ambiente do servidor.
const response = await fetch('https://api.staging.agilink.io/v1/webhooks', {
  method: 'POST',
  headers: {
  "Authorization": `Bearer ${process.env.AGILINK_API_KEY}`,
  "Idempotency-Key": "10000000-0000-4000-8000-000000000001",
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "appId": "app_loja",
  "name": "Integração",
  "url": "https://hooks.example.com/agilink",
  "events": [
    "link.created"
  ]
}),
  redirect: 'error', signal: AbortSignal.timeout(30000)
});
if (!response.ok) throw new Error('HTTP '+response.status+' requestId='+response.headers.get('X-Request-Id'));
const result = await response.json();
// Guarde result.data.secret no gerenciador de segredos; não registre em logs.

Python

# Python 3.10+; pip install requests
import os
import requests
headers = {
  "Authorization": "Bearer " + os.environ["AGILINK_API_KEY"],
  "Idempotency-Key": "10000000-0000-4000-8000-000000000001"
}
response = requests.request(
    'POST', 'https://api.staging.agilink.io/v1/webhooks',
    headers=headers, json={"appId":"app_loja","name":"Integração","url":"https://hooks.example.com/agilink","events":["link.created"]},
    timeout=30, allow_redirects=False)
if not 200 <= response.status_code < 300:
    raise RuntimeError(f'HTTP {response.status_code}; requestId={response.headers.get("X-Request-Id")}')
result = response.json()
# Guarde result["data"]["secret"] com segurança; não registre em logs.

Response 201

Criado. Exemplo fictício.

Header	Significado	Exemplo
X-Request-Id	Identificador gerado pelo servidor, inclusive para falhas e replays.	conforme resposta
Cache-Control	Respostas administrativas não podem ser armazenadas.	no-store, no-transform
ETag	Revisão forte, a enviar em If-Match na alteração.	“20000000-0000-4000-8000-000000000001”
Location	Recurso criado.	/v1/webhooks/b0000000-0000-4000-8000-000000000001

{
  "data": {
    "webhook": {
      "id": "b0000000-0000-4000-8000-000000000001",
      "appId": "app_loja",
      "name": "Integração",
      "url": "https://hooks.example.com/agilink",
      "events": [
        "link.created"
      ],
      "enabled": true,
      "failures": 0,
      "revision": "20000000-0000-4000-8000-000000000001",
      "previousSecretExpiresAt": null,
      "createdAt": "2026-10-20T01:00:00Z",
      "updatedAt": "2026-10-20T01:00:00Z"
    },
    "secret": "whsec_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
  },
  "meta": {
    "requestId": "req_00000000000040008000000000000001"
  }
}

Campo	Tipo	Obrigatório	Significado e limites
data	object	sim	Resultado tipado da operação.
data.webhook	Webhook	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.webhook.id	string	sim	Identificador estável do recurso. uuid
data.webhook.appId	AppId	sim	Aplicativo proprietário; precisa estar autorizado.
data.webhook.name	string	sim	Nome de exibição. Até 100 caracteres; Formato validado pelo schema
data.webhook.url	string	sim	Endereço do recurso; não acrescente credenciais. Até 2048 caracteres; uri; Formato validado pelo schema
data.webhook.events	array	sim	Valor tipado; formato e restrições completos no schema abaixo. Até 9 itens
data.webhook.enabled	boolean	sim	Habilitação sujeita às capacidades e à autorização atual.
data.webhook.failures	integer	sim	Valor tipado; formato e restrições completos no schema abaixo. Mínimo 0
data.webhook.revision	string	sim	Revisão forte para If-Match; muda ao editar. uuid
data.webhook.previousSecretExpiresAt	string ou null	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.webhook.createdAt	string	sim	Instante de criação com fuso. date-time
data.webhook.updatedAt	string	sim	Instante da última alteração. date-time
data.secret	string	sim	Exibido apenas na emissão; armazene no servidor. Formato validado pelo schema
meta	Meta	sim	Correlação e informações da resposta.
meta.requestId	RequestId	sim	Identificador de correlação gerado pelo servidor.

Falhas, revisão e repetição

Idempotency-Key UUID v4 é obrigatório, por intenção e credencial, por 24 horas. Em resultado incerto, repita exatamente o mesmo método, URL, corpo, revisão e chave. Alterar a intenção exige nova chave. Segredos de emissão não são reexibidos. Esta operação não exige If-Match. Não faça retry automático ilimitado.

Status	Significado
400	Cabeçalho, query, cursor ou JSON inválido.
401	Credencial inválida, expirada ou revogada.
403	Operação sem permissão ou capacidade desabilitada.
404	Recurso inexistente ou fora dos aplicativos autorizados.
409	Conflito de identidade/idempotência; operação em andamento ou segredo já exibido.
413	Corpo excede o limite.
415	Content-Type incompatível.
422	JSON bem formado com dados de domínio inválidos.
429	Quota excedida. Respeitar Retry-After.
500	Falha interna. Use requestId para diagnóstico.
503	Dependência indisponível; resultado da mutação pode ser incerto.

Exemplo 401

{
  "error": {
    "code": "unauthenticated",
    "message": "Credencial inválida, expirada ou revogada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#unauthenticated"
  }
}

Exemplo 403

{
  "error": {
    "code": "insufficient_permission",
    "message": "Operação sem permissão ou capacidade desabilitada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#insufficient-permission"
  }
}

Exemplo 409

{
  "error": {
    "code": "idempotency_conflict",
    "message": "Conflito de identidade/idempotência; operação em andamento ou segredo já exibido.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#idempotency-conflict"
  }
}

Exemplo 429

{
  "error": {
    "code": "rate_limited",
    "message": "Quota excedida. Respeitar Retry-After.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#rate-limited"
  }
}

Schema completo e próximos passos

Schema de request

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "appId": {
      "$ref": "#/components/schemas/AppId"
    },
    "name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "pattern": "^[^\\u0000-\\u001f\\u007f]+$"
    },
    "url": {
      "type": "string",
      "maxLength": 2048,
      "format": "uri",
      "pattern": "^https://[^/@?#\\s]+(?:/[^#]*)?$"
    },
    "events": {
      "type": "array",
      "items": {
        "enum": [
          "link.created",
          "link.updated",
          "link.deleted",
          "domain.status_changed",
          "template.publication_succeeded",
          "template.publication_failed",
          "operation.completed",
          "operation.failed",
          "export.ready"
        ]
      },
      "maxItems": 9,
      "minItems": 1,
      "uniqueItems": true
    }
  },
  "required": [
    "appId",
    "name",
    "url",
    "events"
  ]
}

Schema de response

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "webhook": {
          "$ref": "#/components/schemas/Webhook"
        },
        "secret": {
          "type": "string",
          "pattern": "^whsec_[A-Za-z0-9_-]{43}$"
        }
      },
      "required": [
        "webhook",
        "secret"
      ]
    },
    "meta": {
      "$ref": "#/components/schemas/Meta"
    }
  },
  "required": [
    "data",
    "meta"
  ]
}

Convenções e limites · Erros · Receitas completas · Guia funcional.