> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hoppier.com/llms.txt
> Use this file to discover all available pages before exploring further.

# card.claimed

> The card.claimed webhook: its payload, the X-Hoppier-Signature header and how Hoppier retries.

> [!WARNING]
>
> `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](/guides/webhooks.md).


## OpenAPI

````yaml openapi.yaml webhook card.claimed
openapi: 3.1.0
info:
  title: Hoppier API
  version: 1.0.0-beta
  summary: Read your Hoppier programs and add people to them.
  description: >
    The Hoppier API is in **closed beta**. Everything in this reference runs in
    production today.


    - API keys are issued by Hoppier during the beta. Email
    [support@hoppier.com](mailto:support@hoppier.com) to request one.

    - There is no sandbox. Every key works against your live account.

    - We add fields and error codes without notice, so ignore anything you don't
    recognise. We don't rename or remove a documented field without announcing
    it on the [changelog](https://docs.hoppier.com/changelog) first.
  termsOfService: https://www.hoppier.com/terms
  contact:
    name: Hoppier support
    email: support@hoppier.com
servers:
  - url: https://app.hoppier.com/api/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: Account
    description: Check an API key and see which account it belongs to.
  - name: Programs
    description: Read the reward programs in your account.
  - name: Participants
    description: Add people to a program.
paths: {}
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: hk_live.<prefix>.<secret>
      description: >
        Send your key in the `Authorization` header: `Authorization: Bearer
        hk_live.…`. The word `Bearer` is case-sensitive.


        Keys are issued by Hoppier during the beta and shown once. Treat them
        like passwords and never put one in code that runs in a browser or an
        app.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.