Skip to main content
POST
/
api
/
webhooks-config
Configurar webhook
curl --request POST \
  --url https://sandbox.ntxpay.com/api/webhooks-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhooks/mx",
  "events": [
    "cash_in",
    "cash_out"
  ],
  "secret": "whsec_abc123"
}
'
{
  "id": 42,
  "url": "https://example.com/webhooks/mx",
  "events": [
    "cash_in",
    "cash_out"
  ],
  "isActive": true,
  "secret": "whsec_abc123"
}

Authorizations

​
Authorization
string
header
required

JWT obtido em POST /api/auth/token

Body

application/json
​
url
string<uri>
required

URL HTTPS que receberá os webhooks

Example:

"https://example.com/webhooks/mx"

​
events
enum<string>[]
required
Required array length: 1 - 5 elements
Available options:
cash_in,
cash_out,
refund_in,
refund_out,
internal_transfer
Example:
["cash_in", "cash_out"]
​
secret
string

Secret HMAC para assinatura. Se omitido, o NTX Pay gera automaticamente.

Required string length: 8 - 128
Example:

"whsec_abc123"

Response

Webhook configurado

​
id
integer
Example:

42

​
url
string
Example:

"https://example.com/webhooks/mx"

​
events
string[]
Example:
["cash_in", "cash_out"]
​
isActive
boolean
Example:

true

​
secret
string

Secret gerado pelo NTX Pay — exibido apenas na criação. Guarde com segurança.

Example:

"whsec_abc123"