Skip to main content
POST
/
api
/
v1
/
webhooks
/
subscriptions
Criar assinatura de webhook
curl --request POST \
  --url https://upay-sistema-api.onrender.com/api/v1/webhooks/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>",
  "events": [
    "transaction.created"
  ],
  "isActive": true
}
'
{
  "message": "<string>",
  "subscription": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "isActive": true,
    "lastTriggeredAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Chave de API obtida através do endpoint /api/credentials. Também aceita formato Bearer Token: Authorization: Bearer <api_key>

Body

application/json
​
url
string<uri>
required
​
events
enum<string>[]
required
Available options:
transaction.created,
transaction.updated,
transaction.completed,
transaction.failed,
payment_link.created,
payment_link.updated,
balance.updated
​
isActive
boolean
default:true

Response

Assinatura criada com sucesso

​
message
string
​
subscription
object