Referência / Webhooks

Criar webhook

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

Criar webhook

Ambiente

Autenticação Basic

Base64

Basic:

Esta requisição pode criar, alterar ou remover dados no ambiente selecionado.

cURL

Exemplo gerado

1curl --request POST \2  --url 'https://staging-eaglecash.coinnodes.tech/api/v1/user/webhook/{webhook_type}' \3  --header 'accept: application/json' \4  --header 'Authorization: Basic BASE64(SUA_API_KEY:SEU_SECRET_KEY)' \5  --header 'content-type: application/json' \6  --data '{7  "user_id": 0,8  "webhook_route": ""9}'

Resposta

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

Parâmetros de path

1 campo

webhook_typestring · enumObrigatório

Campo documentado pela API.

Valores: pix_inpix_outaccount

Parâmetros do body

4 campos

user_idintegerObrigatório

Campo documentado pela API.

webhook_routestringObrigatório

Campo documentado pela API.

webhook_api_keystringOpcional

Campo documentado pela API.

webhook_secret_keystringOpcional

Campo documentado pela API.

Resposta

200WebhookItemResponse

Successful Response

Campos da resposta

6 campos

idstringObrigatório

Campo documentado pela API.

created_atstringObrigatório

Campo documentado pela API.

updated_atstringObrigatório

Campo documentado pela API.

webhook_routestringObrigatório

Campo documentado pela API.

webhook_api_keystringOpcional

Campo documentado pela API.

webhook_secret_keystringOpcional

Campo documentado pela API.

Status HTTP

200

Successful Response

422

Validation Error