Pular para o conteúdo principal

Criar um Webhook

POST 
/v2/webhooks

Informações adicionais​

Utilize esta requisição para criar novos Webhooks para receber as notificações de eventos ocorridos na plataforma.

Na criação do Webhook a URL informada no cadastro deve ser responsiva, ou seja, deverá responder (HTTP Status 200 OK) a uma requisição (HTTP POST) que será feita para testar se a URL está operando como normalmente, caso contrario uma mensagem de erro será retornada.

Um Webhook é semelhante a uma assinatura em um sistema de publicação e assinatura que permite ao assinante indicar quando, como e onde as notificações de eventos deve ser despachadas. Um Webhook é registrado e gerenciado por Conta o que significa que cada Conta tem um conjunto separado de ganchos que podem ser acionados por eventos gerados através de ações executadas por esse Conta. Ou seja, a Conta da Empresa A não verá os WebHooks disparados por uma ação executada pelo usuário Conta da Empresa B.

Request​

Responses​

Sucesso na criação da webhook