SharkHub
Webhooks

Referência / Webhooks

Criar webhook

POST/api/v1/user/webhook/{type}

Cria um webhook para o tipo informado. Usuários com perfil Customer só podem criar webhooks para a própria conta. Usuários com perfil Director ou Superuser podem criar para qualquer usuário.

Parâmetros de path

1 campo
typestring · enumObrigatório

Tipo do webhook que será criado.

Valores: pix_inpix_outaccount

Parâmetros do body

4 campos
user_idintegerObrigatório

ID do usuário dono do webhook.

webhook_routestring · uriObrigatório

URL que receberá as notificações por webhook. Deve começar com `https://`.

webhook_api_keystringOpcional

Chave opcional usada como username no HTTP Basic Auth.

webhook_secret_keystringOpcional

Segredo opcional usado como password no HTTP Basic Auth.

Resposta

200WebhookResponse

Webhook criado com sucesso.

JSON · Resposta de sucesso
{
  "id": "0b4f9c2b-1df5-4a2e-b4db-2e9bbd4f0a10",
  "created_at": "2026-04-16T00:00:00",
  "updated_at": "2026-04-16T00:00:00",
  "webhook_route": "https://meusite.com/callback",
  "webhook_api_key": "chave-opcional",
  "webhook_secret_key": "segredo-opcional"
}

Campos da resposta

6 campos
idstring · uuidObrigatório

UUID do webhook.

created_atstring · date-timeObrigatório

Data de criação do webhook.

updated_atstring · date-timeObrigatório

Data da última atualização do webhook.

webhook_routestring · uriObrigatório

URL que recebe as notificações por webhook.

webhook_api_keystringOpcional

Chave usada como username no HTTP Basic Auth.

webhook_secret_keystringOpcional

Segredo usado como password no HTTP Basic Auth. Na listagem e atualização, esse valor pode vir mascarado.

Status HTTP

200

Webhook criado com sucesso.

400

Usuário não encontrado, usuário inativo, URL inválida, limite de webhooks atingido ou usuário com perfil Customer tentando acessar outro usuário.

401

Token Basic ausente ou inválido.

Atualizar webhook PUT

Atualiza apenas os campos enviados no body. Usuários com perfil Customer só podem editar os próprios webhooks. Usuários com perfil Director ou Superuser podem editar webhooks de qualquer usuário.

Excluir webhook DELETE

Remove apenas o webhook indicado pelo `webhook_id`. Se houver outro webhook do mesmo tipo, ele será preservado.