Skip to main content
POST/webhooks/create

Corpo da requisição

urlstringrequired

URL HTTPS de um domínio público, sem porta personalizada ou credenciais.

eventsstring[]required

Eventos que este endpoint receberá.

Descrição que identifica a operação.

Autorização

X-API-Keystringrequired

Chave VibeCash com permissão para esta operação.

Resposta

201 application/json
successbooleanrequired

Indica se a operação foi concluída pela API.

messagestringrequired

Mensagem da operação.

dataobjectrequired

Dados retornados pela operação.

Show child attributes
itemobject

Endpoint cadastrado.

secretstring

Segredo HMAC exibido uma única vez.

requestIdstring

Identificador da requisição.

Erros

As falhas retornam o envelope com success: false. Consulte erros e códigos HTTP para interpretar validação, permissão, conflito e saldo insuficiente.

curl --request POST \
  --url 'https://seu-dominio/v1/webhooks/create' \
  --header 'X-API-Key: tp_live_SUA_CHAVE' \
  --header 'Content-Type: application/json' \
  --data '{"url":"https://seu-dominio.com/webhook","events":["payment.paid","withdrawal.completed"],"description":"Minha integração"}'
{
  "success": true,
  "message": "Operação concluída",
  "data": {
    "item": {
      "id": "wh_exemplo",
      "url": "https://seu-dominio.com/webhook",
      "events": [
        "payment.paid"
      ],
      "status": "Ativo"
    },
    "secret": "SEGREDO_EXIBIDO_UMA_VEZ"
  },
  "requestId": "req_exemplo"
}

Pesquisar documentação

POST

Criar webhook

Receba eventos assinados no seu servidor.

Authorization
Body
Expand 1 optional fields