Avistadocs

List account webhooks

GET /api/webhooks

Returns all webhooks configured for the authenticated account.

Authentication

Requires a Bearer token in the Authorization header.

Response (200)

FieldTypeDescription
accountIdnumberAccount ID
webhooksarrayList of configured webhooks
webhooks[].idnumberUnique webhook identifier
webhooks[].typestringEvent type: cash_in, cash_out, refund_in, refund_out
webhooks[].urlstringConfigured endpoint URL
webhooks[].headersobjectCustom headers (key-value)
webhooks[].isActivebooleanIndicates whether the webhook is active
webhooks[].createdAtstringCreation date (ISO 8601)
totalnumberTotal number of configured webhooks
{
  "accountId": 93,
  "webhooks": [
    {
      "id": 1,
      "type": "cash_in",
      "url": "https://api.example.com/webhooks/pix",
      "headers": {
        "Authorization": "Bearer token123"
      },
      "isActive": true,
      "createdAt": "2025-01-09T12:00:00.000Z"
    }
  ],
  "total": 4
}

Errors

StatusDescription
401Missing or invalid token
404Account not found

On this page