Cadastrar/Alterar Webhook

Cadastra um novo webhook para recebimento de mensagens de um determinado tipo. Caso já exista uma configuração anterior, os dados serão sobrescritos.

A chamada deverá ser feita utilizando o método POST.

URL

{BaseUrl}/api/v1/webhooks

HTTP Request Body

{
    "url": "https://test2.com",
    "authorization": "authorization_value"
}

Descrição dos Atributos

ATRIBUTO	DESCRIÇÃO	TIPO
url (Obrigatório)	Endereço destino da mensagem do webhook	STRING limite de 255 caracteres iniciando com https://
authorization (Opcional)	Valor que será enviado no header Authorization para comprovar que é a Pay2m que está enviando a mensagem	STRING limite de 100 caracteres

Em caso de sucesso, será retornada uma mensagem informando o êxito da operação com código HTTP 201 em caso de cadastro de uma nova configuração de webhook, e HTTP 200 para atualização dos dados.

HTTP 201 Response Body - Exemplo

{
    "message": "Operation succeeded"
}