Skip to Content

ping

You asked for a test with POST /api/v1/webhooks/{webhook_id}/test. Every subscription gets it; you cannot subscribe to it. data: message.

Header Parameters

CharpstAR-Event*string
CharpstAR-Delivery*string

The delivery id; the same on every retry.

Formatuuid
CharpstAR-Signature*string

t=,v1=<hex HMAC SHA-256 of t + '.' + raw body, keyed with your whsec_ secret>

User-Agent*string

Request Body

application/json
  1. body
id*string

The delivery id; the same as the CharpstAR-Delivery header and the same on every retry.

Formatuuid
type*string
occurredAt*string

When it happened on our side.

Formatdate-time
client*

The company the key belongs to.

article*|

The article number the event is about, or null when the event is not about one product.

data*

Response Body

Any 2xx within 10 seconds means handled. Anything else is retried.

Example Requests
POST/ping
Request Body
application/json
{  "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",  "type": "ping",  "occurredAt": "2026-10-20T09:31:00.000Z",  "client": {    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",    "name": "Your Company"  },  "article": null,  "data": {    "message": "Test notification from CharpstAR."  }}
Header Parameters
{  "CharpstAR-Event": "ping",  "CharpstAR-Delivery": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "CharpstAR-Signature": "string",  "User-Agent": "CharpstAR-Webhooks/1"}