Referência / Webhooks

Listar webhooks

GET/api/v1/user/webhook/{user_id}

Lista os webhooks de um usuário. Sem o parâmetro `webhook_type`, retorna todos os tipos. A `webhook_secret_key` é sempre mascarada na resposta.

Ambiente

Autenticação Basic

Base64

Basic:

cURL

Exemplo gerado

1curl --request GET \2  --url 'https://staging.sharktecnologia.com/api/v1/user/webhook/{user_id}' \3  --header 'accept: application/json' \4  --header 'Authorization: Basic BASE64(SUA_API_KEY:SEU_SECRET_KEY)'

Resposta

Clique em Executar para enviar a requisição e visualizar a resposta aqui.

Parâmetros de path

1 campo

user_idintegerObrigatório

ID do usuário dono dos webhooks.

Parâmetros de query

1 campo

webhook_typestring · enumOpcional

Filtra a listagem por tipo de webhook.

Valores: pix_inpix_outaccount

Resposta

200WebhookListResponse

Webhooks retornados com sucesso.

JSON · Resposta de sucesso

{
  "webhook_pix_in": [
    {
      "id": "0b4f9c2b-1df5-4a2e-b4db-2e9bbd4f0a10",
      "created_at": "2026-04-16T00:00:00",
      "updated_at": "2026-04-16T00:00:00",
      "webhook_route": "https://site.com/pix-in",
      "webhook_api_key": "chave",
      "webhook_secret_key": "secr****cret"
    }
  ],
  "webhook_pix_out": null,
  "webhook_account": null
}

Campos da resposta

3 campos

webhook_pix_inarray<object>Opcional

Webhooks de Pix In cadastrados para o usuário.

webhook_pix_outarray<object>Opcional

Webhooks de Pix Out cadastrados para o usuário.

webhook_accountarray<object>Opcional

Webhooks de conta cadastrados para o usuário.

Status HTTP

200

Webhooks retornados com sucesso.

400

Usuário não encontrado, usuário inativo ou Customer tentando acessar outro usuário.

401

Token Basic ausente ou inválido.