Skip to main content
GET
https://api.chariow.com/v1
/
pulses
/
{pulsePublicId}
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

Available Trigger Events

Pulses can be configured to trigger on the following events:

Sale Events

ValueLabelDescription
successful_saleSuccessful SaleTriggers when a sale is successful.
abandoned_saleAbandoned SaleTriggers when a sale is abandoned.
failed_saleFailed SaleTriggers when a sale fails.

License Events

ValueLabelDescription
license_activatedLicense ActivatedTriggers when a license is activated.
license_expiredLicense ExpiredTriggers when a license expires.
license_issuedLicense IssuedTriggers when a license is issued to a customer.
license_revokedLicense RevokedTriggers when a license is revoked.

Special Events

ValueLabelDescription
allAll EventsTriggers 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": []
}