`POST /v1/webhook-endpoints`

Use os campos e permissões documentados para este endpoint HTTP.

Exemplo de solicitação#

curl -X POST 'https://platform.tongai.io/v1/webhook-endpoints' \  -H "Authorization: Bearer $TONG_API_KEY" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: 45be69f1-c266-4a09-a82c-bf3c6303eb03" \  -d '{  "url": "https://your-app.example/events",  "events": [    "operation.accepted"  ]}'

Configuração

curl --version

Autenticação#

Use uma chave API no servidor para sua conta, ou OAuth para a conta de cada cliente. Nunca envie chaves em prompts ou argumentos.

webhooks:manageoperations:read

Parâmetros#

Idempotency-KeystringObrigatório

Um UUID, por exemplo e8aa0a87-6cd9-42eb-975a-b72bf43218c8.

Corpo da solicitação#

application/json

urlstringObrigatório

Formato: uri.

Comprimento máximo: 2000 caracteres.

eventsstring[]Obrigatório

Mínimo de itens: 1.

Máximo de itens: 14.

Esquema de resposta#

Resposta

JSON

{}

`HTTP 201`

application/json

object

Erros e limites#

HTTP	Erro	Recuperação
`400`	Solicitação inválida`REQUEST_INVALID`	Corrija os campos indicados pelo erro antes de tentar novamente.
`401`	Credencial inválida`CREDENTIAL_INVALID`	Verifique a credencial, a validade e se foi revogada.
`402`	Créditos insuficientes`INSUFFICIENT_CREDITS`	Adicione créditos à conta da credencial e continue o trabalho salvo.
`403`	Permissão negada`SCOPE_REQUIRED`	Use uma credencial com os escopos necessários e acesso ao recurso selecionado.
`404`	Recurso indisponível`RESOURCE_UNAVAILABLE`	Verifique o ID do recurso e se pertence à conta autorizada.
`409`	Conflito de intenção`IDEMPOTENCY_CONFLICT`	Reutilize uma intenção apenas com a solicitação original. Use um novo UUID para outra ação.
`429`	Limite de requisições atingido`RATE_LIMITED`	Aguarde o prazo de Retry-After antes de repetir a mesma solicitação.
`503`	Temporariamente indisponível`DEPENDENCY_UNAVAILABLE`	Aguarde Retry-After e repita com a mesma intenção. Verifique a operação salva após um tempo limite.

AutenticaçãoAs chaves de API cobram da conta proprietária. O OAuth permite que cada usuário conectado use seus créditos.Erros e limites de requisiçõesEntenda os erros, tente novamente com segurança e recupere gerações com falha.Solicitações e registrosUma solicitação aceita não é uma geração concluída. Acompanhe o trabalho até o resultado estar pronto.