curl -X GET "https://api.chariow.com/v1/pulses/pulse_abc123xyz" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch('https://api.chariow.com/v1/pulses/pulse_abc123xyz', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
});
const data = await response.json();
$ch = curl_init('https://api.chariow.com/v1/pulses/pulse_abc123xyz');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
{
"message": "success",
"data": {
"id": "pulse_abc123xyz",
"url": "https://example.com/webhooks/chariow",
"is_enabled": true,
"source": {
"value": "manual",
"label": "Manual",
"description": "Created manually by user"
},
"triggers": [
{
"value": "successful_sale",
"label": "Successful Sale",
"description": "Triggers when a sale is successful."
},
{
"value": "license_activated",
"label": "License Activated",
"description": "Triggers when a license is activated."
}
],
"products": [
{
"id": "prd_xyz789",
"name": "Premium Course",
"slug": "premium-course"
}
],
"store": {
"id": "str_abc123",
"name": "My Digital Store"
},
"can_delete": true,
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-15T10:30:00+00:00"
},
"errors": []
}
{
"message": "Pulse not found",
"data": [],
"errors": []
}
Pulses
Get Pulse
Retrieve details of a specific webhook notification pulse
curl -X GET "https://api.chariow.com/v1/pulses/pulse_abc123xyz" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch('https://api.chariow.com/v1/pulses/pulse_abc123xyz', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
});
const data = await response.json();
$ch = curl_init('https://api.chariow.com/v1/pulses/pulse_abc123xyz');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
{
"message": "success",
"data": {
"id": "pulse_abc123xyz",
"url": "https://example.com/webhooks/chariow",
"is_enabled": true,
"source": {
"value": "manual",
"label": "Manual",
"description": "Created manually by user"
},
"triggers": [
{
"value": "successful_sale",
"label": "Successful Sale",
"description": "Triggers when a sale is successful."
},
{
"value": "license_activated",
"label": "License Activated",
"description": "Triggers when a license is activated."
}
],
"products": [
{
"id": "prd_xyz789",
"name": "Premium Course",
"slug": "premium-course"
}
],
"store": {
"id": "str_abc123",
"name": "My Digital Store"
},
"can_delete": true,
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-15T10:30:00+00:00"
},
"errors": []
}
{
"message": "Pulse not found",
"data": [],
"errors": []
}
Retrieves detailed information about a specific pulse webhook by its public ID, including configured triggers, associated products, source information, and current status.
Path Parameters
The unique pulse identifier (e.g.,
pulse_abc123)Response
Show properties
Show properties
Unique pulse identifier (e.g.,
pulse_abc123xyz)Webhook URL where notifications are sent
Whether the pulse is currently active
Whether the pulse can be deleted. Only manually created pulses can be deleted.
ISO 8601 timestamp with timezone
ISO 8601 timestamp with timezone
Available Trigger Events
Pulses can be configured to trigger on the following events:Sale Events
| Value | Label | Description |
|---|---|---|
successful_sale | Successful Sale | Triggers when a sale is successful. |
abandoned_sale | Abandoned Sale | Triggers when a sale is abandoned. |
failed_sale | Failed Sale | Triggers when a sale fails. |
License Events
| Value | Label | Description |
|---|---|---|
license_activated | License Activated | Triggers when a license is activated. |
license_expired | License Expired | Triggers when a license expires. |
license_issued | License Issued | Triggers when a license is issued to a customer. |
license_revoked | License Revoked | Triggers when a license is revoked. |
Special Events
| Value | Label | Description |
|---|---|---|
all | All Events | Triggers for all events. |
curl -X GET "https://api.chariow.com/v1/pulses/pulse_abc123xyz" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch('https://api.chariow.com/v1/pulses/pulse_abc123xyz', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
});
const data = await response.json();
$ch = curl_init('https://api.chariow.com/v1/pulses/pulse_abc123xyz');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
{
"message": "success",
"data": {
"id": "pulse_abc123xyz",
"url": "https://example.com/webhooks/chariow",
"is_enabled": true,
"source": {
"value": "manual",
"label": "Manual",
"description": "Created manually by user"
},
"triggers": [
{
"value": "successful_sale",
"label": "Successful Sale",
"description": "Triggers when a sale is successful."
},
{
"value": "license_activated",
"label": "License Activated",
"description": "Triggers when a license is activated."
}
],
"products": [
{
"id": "prd_xyz789",
"name": "Premium Course",
"slug": "premium-course"
}
],
"store": {
"id": "str_abc123",
"name": "My Digital Store"
},
"can_delete": true,
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-15T10:30:00+00:00"
},
"errors": []
}
{
"message": "Pulse not found",
"data": [],
"errors": []
}
Was this page helpful?
⌘I