List Pulses - Chariow Developers

curl -X GET "https://api.chariow.com/v1/pulses?per_page=20&search=webhook" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "message": "success",
  "data": {
    "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": [],
        "store": {
          "id": "str_xyz789",
          "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"
      },
      {
        "id": "pulse_def456abc",
        "url": "https://hooks.zapier.com/hooks/catch/12345/abcde",
        "is_enabled": true,
        "source": {
          "value": "zapier",
          "label": "Zapier",
          "description": "Created via Zapier integration"
        },
        "triggers": [
          {
            "value": "successful_sale",
            "label": "Successful Sale",
            "description": "Triggers when a sale is successful."
          }
        ],
        "products": [
          {
            "id": "prd_xyz789",
            "name": "Premium Course",
            "slug": "premium-course"
          }
        ],
        "store": {
          "id": "str_xyz789",
          "name": "My Digital Store"
        },
        "can_delete": false,
        "created_at": "2025-01-10T08:00:00+00:00",
        "updated_at": "2025-01-10T08:00:00+00:00"
      }
    ],
    "pagination": {
      "next_cursor": "eyJpZCI6NTB9",
      "prev_cursor": null,
      "has_more": true
    }
  },
  "errors": []
}

curl -X GET "https://api.chariow.com/v1/pulses?per_page=20&search=webhook" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "message": "success",
  "data": {
    "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": [],
        "store": {
          "id": "str_xyz789",
          "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"
      },
      {
        "id": "pulse_def456abc",
        "url": "https://hooks.zapier.com/hooks/catch/12345/abcde",
        "is_enabled": true,
        "source": {
          "value": "zapier",
          "label": "Zapier",
          "description": "Created via Zapier integration"
        },
        "triggers": [
          {
            "value": "successful_sale",
            "label": "Successful Sale",
            "description": "Triggers when a sale is successful."
          }
        ],
        "products": [
          {
            "id": "prd_xyz789",
            "name": "Premium Course",
            "slug": "premium-course"
          }
        ],
        "store": {
          "id": "str_xyz789",
          "name": "My Digital Store"
        },
        "can_delete": false,
        "created_at": "2025-01-10T08:00:00+00:00",
        "updated_at": "2025-01-10T08:00:00+00:00"
      }
    ],
    "pagination": {
      "next_cursor": "eyJpZCI6NTB9",
      "prev_cursor": null,
      "has_more": true
    }
  },
  "errors": []
}

Retrieves a cursor-paginated list of all pulse webhooks configured for your store. Pulses are webhook notifications sent to your specified endpoints when specific events occur, such as successful sales, abandoned sales, or license activations.

Query Parameters

per_page

integer

default:"15"

Number of pulses to return per page (maximum 100)

cursor

string

Cursor for pagination. Use the next_cursor from the previous response to retrieve the next page.

string

Search pulses by URL, public ID, or trigger event names

Response

data

object

Show properties

data

array

Array of pulse objects

Show pulse object

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. System-created pulses cannot be deleted.

created_at

string

ISO 8601 timestamp with timezone

updated_at

string

ISO 8601 timestamp with timezone

pagination

object

Cursor pagination metadata

Show pagination object

next_cursor

string|null

Cursor for the next page, or null if no more pages

prev_cursor

string|null

Cursor for the previous page, or null if on first page

has_more

boolean

Whether there are more items to fetch

curl -X GET "https://api.chariow.com/v1/pulses?per_page=20&search=webhook" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "message": "success",
  "data": {
    "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": [],
        "store": {
          "id": "str_xyz789",
          "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"
      },
      {
        "id": "pulse_def456abc",
        "url": "https://hooks.zapier.com/hooks/catch/12345/abcde",
        "is_enabled": true,
        "source": {
          "value": "zapier",
          "label": "Zapier",
          "description": "Created via Zapier integration"
        },
        "triggers": [
          {
            "value": "successful_sale",
            "label": "Successful Sale",
            "description": "Triggers when a sale is successful."
          }
        ],
        "products": [
          {
            "id": "prd_xyz789",
            "name": "Premium Course",
            "slug": "premium-course"
          }
        ],
        "store": {
          "id": "str_xyz789",
          "name": "My Digital Store"
        },
        "can_delete": false,
        "created_at": "2025-01-10T08:00:00+00:00",
        "updated_at": "2025-01-10T08:00:00+00:00"
      }
    ],
    "pagination": {
      "next_cursor": "eyJpZCI6NTB9",
      "prev_cursor": null,
      "has_more": true
    }
  },
  "errors": []
}

Get Discount Get Pulse

​Query Parameters

​Response

Query Parameters

Response