Partner Guide

Buzz API Reference

Server-to-server APIs for in-app quest events and Buzz Links conversion postbacks. Requests use JSON bodies with HMAC-SHA256 authentication.

Quick reference

IntegrationMethod & pathKey header
In-app quest eventsPOST /user/inapp/webhooksX-Buzz-Key-Id
Conversion postbackPOST /user/conversions/postbackX-Buzz-Key

Key concepts

1
Different credentials per integration
In-app webhooks use X-Buzz-Key-Id from campaign in-app integration keys. Conversion postbacks use X-Buzz-Key, your project API key. Same signing algorithm — different header names.
2
Every request is signed
All requests require a timestamp (X-Buzz-Timestamp) and HMAC-SHA256 signature (X-Buzz-Signature). The timestamp must be within ±300 seconds of server time.
3
Async processing
HTTP 200 means the payload was accepted. Heavy work — point awards, campaign matching — runs in background jobs. Use campaign event visibility in your ops flow to confirm outcomes.
4
Base URL
All examples default to https://padapi.chaingpt.dev. Both endpoints use the public user prefix /user/…. No end-user JWT is required — API key headers + signature only.

Rate limits

100
req / min
In-app webhooks
per key-id · rolling window
60
req / min
Conversion postback
per X-Buzz-Key · rolling
When rate limited, the API returns 429 with a Retry-After header. Implement exponential backoff in your client.
Next →
Request signing