Events
List Events
Retrieve a paginated list of webhook events
GET
/
v1
/
events
List events
curl --request GET \
--url https://billing.example.com/v1/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://billing.example.com/v1/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://billing.example.com/v1/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://billing.example.com/v1/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://billing.example.com/v1/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://billing.example.com/v1/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://billing.example.com/v1/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "invoice.paid",
"object_type": "<string>",
"object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data": {},
"created_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
}
}Query Parameters
| Parameter | Type | Description |
|---|---|---|
type | string | Filter by event type (e.g. invoice.paid) |
object_id | string (uuid) | Filter to one object’s events — a per-object timeline. Takes precedence over type |
limit | integer | Max results (default: 50, capped at 500) |
offset | integer | Pagination offset |
Example Request
curl "https://api.recurso.dev/v1/events?type=invoice.paid&limit=5" \
-H "Authorization: Bearer $API_KEY"
Response
{
"object": "list",
"data": [
{
"id": "evt_a1b2c3d4",
"type": "invoice.paid",
"object_type": "invoice",
"object_id": "inv_001",
"data": {
"id": "inv_001",
"customer_id": "cust_abc123",
"amount": 5899,
"currency": "INR",
"status": "paid"
},
"created_at": "2024-01-15T10:30:00Z"
},
{
"id": "evt_e5f6g7h8",
"type": "invoice.paid",
"object_type": "invoice",
"object_id": "inv_002",
"data": {
"id": "inv_002",
"customer_id": "cust_def456",
"amount": 11999,
"currency": "INR",
"status": "paid"
},
"created_at": "2024-01-14T08:15:00Z"
}
],
"has_more": true,
"total_count": 42
}
Use the
type filter to efficiently retrieve events relevant to your integration, such as payment.failed for retry logic or subscription.canceled for churn tracking.Authorizations
Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.
Query Parameters
Filter to one event type (e.g. invoice.paid).
Filter to one object's events (per-object timeline); takes precedence over type.
Max rows returned (default 50, capped at 500).
Required range:
x <= 500Rows to skip.
Required range:
x >= 0Response
Events for the tenant.
Show child attributes
Show child attributes
⌘I
List events
curl --request GET \
--url https://billing.example.com/v1/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://billing.example.com/v1/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://billing.example.com/v1/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://billing.example.com/v1/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://billing.example.com/v1/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://billing.example.com/v1/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://billing.example.com/v1/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "invoice.paid",
"object_type": "<string>",
"object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data": {},
"created_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
}
}