Registrar novo evento webhook

🔽
POST urlServidor/v1/marketplace/hooks/hook-events

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
`x-token`	string	Sim	Token utilizado para autenticação. Pode ser encontrado no portal da API.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl--request POST \
--location '{{urlServidor}/v1/marketplace/hooks/hook-events' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros Body

{
  "events": [
    {
      "event_id": 1,
      "active": true,
      "url": "https://meusistema.com.br/webhook-receiver",
      "basic_user": "usuario_webhook",
      "basic_pass": "senha_segura"
    }
  ]
}

📤Explicação do Payload

Campo	Tipo	Obrigatório	Descrição
events	Array	Sim	Lista de eventos webhook a serem registrados ou atualizados.
event_id	Number	Sim	ID do evento a ser associado ao webhook.
active	Boolean	Sim	Indica se o webhook está ativo (`true`) ou inativo (`false`).
url	String	Condicional	URL de recebimento do webhook — obrigatória quando `active` for `true`.
basic_user	String	Opcional	Usuário para autenticação básica HTTP.
basic_pass	String	Opcional	Senha para autenticação básica HTTP.

📤 Resposta (Exemplo)

{
    "events": [
        {
            "id": 5,
            "name": "new-sub-transaction",
            "description": "Nova transação Sub.",
            "active": true,
            "url": "https://meusistema.com.br/webhook-receiver",
            "basic_user": null,
            "basic_pass": null,
            "created_at": "2025-09-15T20:01:46.000Z",
            "updated_at": "2025-09-15T20:01:46.000Z"
        }
    ]
}

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.