Get Pulse

curl -X GET "https://api.chariow.com/v1/pulses/pulse_abc123xyz789" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch('https://api.chariow.com/v1/pulses/pulse_abc123xyz789', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await response.json();

$ch = curl_init('https://api.chariow.com/v1/pulses/pulse_abc123xyz789');
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);

{
  "data": {
    "id": "pulse_abc123xyz789",
    "url": "https://example.com/webhooks/chariow",
    "is_enabled": true,
    "masked_secret": "whsec_••••a1b2",
    "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": [],
    "store": {
      "id": "str_xyz789",
      "name": "My Digital Store",
      "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
      "url": "https://mystore.mychariow.com"
    },
    "is_editable": true,
    "created_at": "2025-01-15T10:30:00+00:00",
    "updated_at": "2025-01-15T10:30:00+00:00"
  }
}

{
  "message": "We couldn't find this Pulse.",
  "errors": []
}

{
  "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
  "errors": []
}

{
  "message": "This credential is missing the required scope: webhooks.read. Update its permissions in your dashboard.",
  "data": [],
  "errors": {
    "scopes": ["webhooks.read"]
  }
}

curl -X GET "https://api.chariow.com/v1/pulses/pulse_abc123xyz789" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch('https://api.chariow.com/v1/pulses/pulse_abc123xyz789', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await response.json();

$ch = curl_init('https://api.chariow.com/v1/pulses/pulse_abc123xyz789');
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);

{
  "data": {
    "id": "pulse_abc123xyz789",
    "url": "https://example.com/webhooks/chariow",
    "is_enabled": true,
    "masked_secret": "whsec_••••a1b2",
    "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": [],
    "store": {
      "id": "str_xyz789",
      "name": "My Digital Store",
      "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
      "url": "https://mystore.mychariow.com"
    },
    "is_editable": true,
    "created_at": "2025-01-15T10:30:00+00:00",
    "updated_at": "2025-01-15T10:30:00+00:00"
  }
}

{
  "message": "We couldn't find this Pulse.",
  "errors": []
}

{
  "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
  "errors": []
}

{
  "message": "This credential is missing the required scope: webhooks.read. Update its permissions in your dashboard.",
  "data": [],
  "errors": {
    "scopes": ["webhooks.read"]
  }
}

Retrieves detailed information about a specific pulse webhook by its public ID, including configured triggers, associated products, source information, and current status.

Requires an API key with the webhooks.read scope (webhooks.write includes it). A key without it receives a 403 listing the missing scope.

Required scope: webhooks.read. A key without it receives a 403 error. See Authentication.

Path Parameters

string

required

The unique pulse identifier (e.g., pulse_abc123xyz789)

Response

object

Show properties

string

Unique pulse identifier (e.g., pulse_abc123xyz789)

string

Webhook URL where notifications are sent

boolean

Whether the pulse is currently active. Chariow sets it to false automatically when a delivery fails all 5 attempts.

string | null

Masked form of the pulse signing secret, e.g. whsec_••••a1b2. The full secret is never returned by the public API; reveal it from the dashboard. See Pulse Security.

object

How the pulse was created

Show source object

string

Source value: manual, zapier, make or n8n

string

Human-readable source label

string

Description of the source

array

Array of trigger event objects that will activate this pulse

Show trigger object

string

Trigger event value (e.g., successful_sale, license_activated, affiliate_joined, all)

string

Human-readable label

string

Description of when this trigger fires

array

Products this pulse is limited to, sorted by creation order. An empty array means every product triggers this pulse. The filter only applies to sale and licence events: affiliate.joined reaches the pulse regardless.

Show product object

string

Product identifier

string

Product name

string

Product type (e.g., course, license, downloadable)

object

thumbnail and cover image URLs

object

Product category, with value and label

object

type, plus price and effective amount objects (value, formatted, short, currency)

object | null

Bundle value and savings, or null when the product is not a bundle

object | null

Custom metadata attached to the product

object

Store information

Show store object

string

Store identifier

string

Store name

string | null

Store logo URL

string

Store URL

boolean

true for pulses created manually. Pulses created by an integration (Zapier, Make, n8n) are managed by that integration and cannot be edited or deleted from Chariow.

string

ISO 8601 timestamp

string

ISO 8601 timestamp

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_nearing_expiry`	License Nearing Expiry	Triggers when a license is approaching its expiry date.
`license_revoked`	License Revoked	Triggers when a license is revoked.

Affiliate Events

Value	Label	Description
`affiliate_joined`	Affiliate Joined	Triggers when an affiliate joins the store.

Special Events

Value	Label	Description
`all`	All Events	Triggers for all events.

Trigger values use underscores (successful_sale). The event field of the webhook payload and the x-pulse-event header use dots (successful.sale). See Pulse Events.

curl -X GET "https://api.chariow.com/v1/pulses/pulse_abc123xyz789" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch('https://api.chariow.com/v1/pulses/pulse_abc123xyz789', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await response.json();

$ch = curl_init('https://api.chariow.com/v1/pulses/pulse_abc123xyz789');
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);

{
  "data": {
    "id": "pulse_abc123xyz789",
    "url": "https://example.com/webhooks/chariow",
    "is_enabled": true,
    "masked_secret": "whsec_••••a1b2",
    "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": [],
    "store": {
      "id": "str_xyz789",
      "name": "My Digital Store",
      "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
      "url": "https://mystore.mychariow.com"
    },
    "is_editable": true,
    "created_at": "2025-01-15T10:30:00+00:00",
    "updated_at": "2025-01-15T10:30:00+00:00"
  }
}

{
  "message": "We couldn't find this Pulse.",
  "errors": []
}

{
  "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
  "errors": []
}

{
  "message": "This credential is missing the required scope: webhooks.read. Update its permissions in your dashboard.",
  "data": [],
  "errors": {
    "scopes": ["webhooks.read"]
  }
}

Overview

Store

Products

Checkout

Sales

Customers

Licenses

Discounts

Pulses

Affiliates

Path Parameters

Response

Available Trigger Events

Sale Events

License Events

Affiliate Events

Special Events

​Path Parameters

​Response

​Available Trigger Events

​Sale Events

​License Events

​Affiliate Events

​Special Events

Path Parameters

Response

Available Trigger Events

Sale Events

License Events

Affiliate Events

Special Events