Cadastrar um Webhook

Esse endpoint permite o cadastro de uma URL para ser utilizada no envio de webhooks durante as etapas da esteira.

Parâmetros da requisição

  • url (string, obrigatório): Campo para a url/endpoint que será requisitada para o envio dos webhooks. Precisa ser uma URL válida e formatada, por exemplo: "https://www.dominio.com/webhooks".

Resposta

Se a requisição for processada com sucesso será retornado um status 201 e um JSON no seguinte formato:

  • id (string/uuid v4): Identificador único do webhook que foi cadastrado.
  • url (string): URL cadastrada para o endpoint dos webhooks.
  • created_at (datetime): Data e hora da criação do cadastro.
  • version (int): Número do versionamento do cadastro.
Exemplo de JSON:
{
  "id": "",
  "url": "",
  "created_at": "",
  "updated_at": "",
  "version": ""
}

Language
URL
Click Try It! to start a request and see the response here!