Webhooks
Send a test event
Sends a synthetic test payload to the endpoint immediately. Useful for verifying
signature verification and endpoint connectivity during integration. The
data.object contains placeholder values, not real store data.
The envelope carries two flags your handler can branch on:
test: true— marks this as a synthetic payload with fake data; skip any side effects (don’t fulfil, charge, or persist). Only events from this endpoint carry it.livemode—falsewhen this request is authenticated with a test key,truewith a live key. Independent oftest: it reflects the key’s environment, not whether the payload is synthetic.
POST
Send a test event
Authorizations
API Key Authentication
Use your API key in the Authorization header:
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_sk_test_*(sandbox) - Full read/write access to all endpoints
- ⚠️ NEVER expose in client-side code or public repositories
- Required for: write operations, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
- Format:
tybrite_pk_live_*(production) ortybrite_pk_test_*(sandbox) - Read-only access (GET requests only, plus POST semantic search)
- ✅ Safe for client-side JavaScript, mobile apps, and public code
- Allowed for: browsing products, search, CMS content, pricing queries
Endpoint-Specific Requirements:
- Authentication endpoints (
/v1/auth/*): Secret key required - Payment verification (
POST /v1/payments/verify): Secret key required - AI Recommendations (
POST /v1/recommendations): Secret key required - Semantic Search (
POST /v1/search): Both key types allowed (read-only operation) - All write operations: Secret key required
- All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Path Parameters
Body
application/json
The event type to simulate.
Available options:
order.created, order.paid, order.fulfilled, order.shipped, order.cancelled, payment.succeeded, payment.failed, customer.created, product.created, product.stock_low, cart.abandoned, gift_card.issued, promotion.applied, promotion.activated, collection.created, post.published, review.approved, store.updated, payment_provider.connected, feature.status_changed, feed.sync.completed, channel.sync.completed 
