Listar Tipos de Webhooks

A API de Webhooks permite que o parceiro configure como receberá as mensagens de notificação originadas pela API Pix. É possível definir uma URL para cada tipo de mensagem e um código de autorização que será enviado como Header Authorization, garantindo assim que a mensagem recebida teve origem na Zendry. Se o parceiro achar necessário, poderá também validar a requisição pelo endereço IP de origem, que poderá ser obtido após solicitação ao atendimento Zendry.

Fazendo Requisição

Retorna uma lista de tipos de notificações existentes. Necessária para utilizar corretamente os endpoints Cadastrar/Alterar Webhook e Remover Webhook.

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

URL

   /v1/webhooks/types

Sucesso

Em caso de sucesso, será retornado uma mensagem HTTP 200 – OK, contendo os dados, conforme apresentado abaixo:

HTTP 200 Response Body - Exemplo

  {
    "webhook_types": [
      {
        "id": 1,
        "name": "pix_qrcodes"
      },
      {
        "id": 2,
        "name": "pix_payments"
      },
    ] 
  }

Descrição dos Atributos

PARÂMETRO	DESCRIÇÃO	TIPO
webhooks_types (Obrigatório)	Lista de tipos de webhooks	ARRAY
webhook_types.id (Obrigatório)	Identificador único do tipo de webhook	NUMBER
webhook_types.name (Obrigatório)	Nome do tipo de webhook	STRING Limite de 255 caracteres