Get Pulse - Chariow Developers

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

{
  "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": []
}

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

{
  "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": []
}

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

Path Parameters

pulsePublicId

string

required

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

Response

data

object

Show properties

string

Unique pulse identifier (e.g., pulse_abc123xyz)

url

string

Webhook URL where notifications are sent

is_enabled

boolean

Whether the pulse is currently active

source

object

Source information about how the pulse was created

Show source object

value

string

Source value: manual, zapier, make, or system

label

string

Human-readable source label

description

string

Description of the source

triggers

array

Array of trigger event objects that will activate this pulse

Show trigger object

value

string

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

label

string

Human-readable label

description

string

Description of when this trigger fires

products

array

Array of products this pulse is limited to. Empty array means all products will trigger this pulse.

Show product object

string

Product identifier

name

string

Product name

slug

string

Product slug

store

object

Store information

Show store object

string

Store identifier

name

string

Store name

can_delete

boolean

Whether the pulse can be deleted. Only manually created pulses can be deleted.

created_at

string

ISO 8601 timestamp with timezone

updated_at

string

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"

{
  "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": []
}

List Pulses Get Affiliate

​Path Parameters

​Response

​Available Trigger Events

​Sale Events

​License Events

​Special Events

Path Parameters

Response

Available Trigger Events

Sale Events

License Events

Special Events