Skip to main content
WEBHOOK
card.claimed means Hoppier has set a reward aside for a participant. It does not mean they spent anything, opened an email or chose a gift card.
It’s sent for gift-card programs only, for now. To register an endpoint, verify the signature and handle retries, see Webhooks.

Headers

X-Hoppier-Signature
string
required

t=<unix seconds>,v1=<signature>, where the signature is the hex HMAC-SHA256 of <t>.<raw request body> with your signing secret. While a secret is being rotated you get two v1= values; accept the request if either matches.

Body

application/json
id
string
required

The event's id. It stays the same on every retry, so use it to ignore duplicates.

Example:

"evt_su_aB3xK9d2Qe"

type
string
required
Allowed value: "card.claimed"
created_at
string<date-time>
required
company_id
string
required

Your company's id. Starts with cpy_.

Example:

"cpy_7Ym2p0Lx3Q"

data
object
required

Response

Answer with any 2xx status within 10 seconds to confirm delivery.