Como gerenciar Webhook

Permitir o gerenciamento (cadastro, atualização e exclusão) do Webhook da empresa cliente a partir de um telefone previamente cadastrado, para que os eventos vindos do WhatsApp sejam enviados para a empresa cliente para seu devido tratamento.

1. Primeiro passo - Obter token de acesso

Antes de solicitar o cadastro, a atualização ou a exclusão do Webhook, a aplicação cliente deve obter o token de acesso às APIs, conforme descrito no guia Como autenticar.

2. Segundo passo – Gerenciamento de Webhook

2.1 - Cadastramento

Após obter o token de acesso, é informado o id do telefone do cliente previamente cadastrado na URI. A partir daí, o cadasto poderá ser feito de três formas:

• informando o usuário e a senha (opcionais), além da URL do Webhook (Json).

{
  "credential": {
    "password": "password-example",
    "username": "username-example"
  },
  "uri": "https://webhook-exemple"
}

• informando o jwtToken (opcional), além da URL do Webhook (Json).

{
  "jwtToken": "token-string",
  "uri": "https://webhook-exemple"
}

• informando somente a URL do Webhook, já que o usuário/senha e jwtToken são opcionais.

{
  "uri": "https://webhook-exemple"
}

Em caso de sucesso, o código retornado é igual a 201, o que indica que o novo Webhook foi criado.

OBS: se o Webhook já existir, o programa atualiza as informações correspondentes.

URI

URI: https://api.whatsapp.serpro.gov.br/client/{fromPhoneNumberId}/v2/webhook
Método: POST

2.2 - Atualização

Após obter o token de acesso, é informado o id do telefone do cliente previamente cadastrado na URI. A partir daí, a atualização poderá ser feita de três formas:

• informando o usuário e a senha (opcionais), além da URL do Webhook (Json).

{
  "credential": {
    "password": "password-example",
    "username": "username-example"
  },
  "uri": "https://webhook-exemple"
}

• informando o jwtToken (opcional), além da URL do Webhook (Json).

{
  "jwtToken": "token-string",
  "uri": "https://webhook-exemple"
}

• informando somente a URL do Webhook, já que o usuário/senha e jwtToken são opcionais.

{
  "uri": "https://webhook-exemple"
}

Em caso de sucesso, o código retornado é igual a 200, o que indica que o Webhook foi atualizado.

URI

URI: https://api.whatsapp.serpro.gov.br/client/{fromPhoneNumberId}/v2/webhook/{id}
Método: PUT

2.3 - Recuperação

Após obter o token de acesso, é informado o id do telefone do cliente previamente cadastrado na URI para a recuperação do Webhook. Em caso de sucesso, o código retornado é igual a 200, o que indica que todos os Webhooks foram recuperados.

URI

URI: https://api.whatsapp.serpro.gov.br/client/{fromPhoneNumberId}/v2/webhook
Método: GET

Para a recuperação de um Webhook específico, utlizar a URI abaixo:

URI

URI: https://api.whatsapp.serpro.gov.br/client/{fromPhoneNumberId}/v2/webhook{id}
Método: GET

2.4 - Exclusão

Após obter o token de acesso, é informado o id do número de telefone do cliente previamente cadastrado na URI para a exclusão do Webhook.

Em caso de sucesso, o código retornado é igual a 200, o que indica que o Webhook foi excluído.

URI

URI: https://api.whatsapp.serpro.gov.br/client/{fromPhoneNumberId}/v2/webhook/{id}
Método: DEL