List account webhooks

GET /api/webhooks

GET https://api.avista.global/api/webhooks

Requires a Bearer token in the Authorization header. See Generate Token to obtain one.

Returns all webhooks configured for the authenticated account.

Authentication

Requires a Bearer token in the Authorization header.

Code Examples

cURL

curl -X GET "https://api.avista.global/api/webhooks" \
  -H "Authorization: Bearer $AVISTA_TOKEN"

const axios = require('axios');

const response = await axios.get('https://api.avista.global/api/webhooks', {
  headers: { 'Authorization': `Bearer ${process.env.AVISTA_TOKEN}` },
});
console.log(response.data);

import os, requests

response = requests.get(
    'https://api.avista.global/api/webhooks',
    headers={'Authorization': f'Bearer {os.environ["AVISTA_TOKEN"]}'},
)
print(response.json())

$ch = curl_init('https://api.avista.global/api/webhooks');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('AVISTA_TOKEN'),
    ],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.avista.global/api/webhooks"))
    .header("Authorization", "Bearer " + System.getenv("AVISTA_TOKEN"))
    .GET()
    .build();
HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response (200)

Field	Type	Description
`accountId`	number	Account ID
`webhooks`	array	List of configured webhooks
`webhooks[].id`	number	Unique webhook identifier
`webhooks[].type`	string	Event type: `cash_in`, `cash_out`, `refund_in`, `refund_out`, `med_created`, `med_accepted`, `med_rejected`
`webhooks[].url`	string	Configured endpoint URL
`webhooks[].headers`	object	Custom headers (key-value)
`webhooks[].isActive`	boolean	Indicates whether the webhook is active
`webhooks[].createdAt`	string	Creation date (ISO 8601)
`total`	number	Total 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

Status	Description
401	Missing or invalid token
404	Account not found