Sign in

v33

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-28103497709.6 KB
Webhooks

Invitation claimed webhook

Webhook that is called when an invitation is claimed by a customer. This endpoint should be implemented by platform clients of the Grid API.

When a customer claims an invitation, this webhook is triggered to notify the platform that:

  1. The invitation has been successfully claimed
  2. The invitee UMA address is now associated with the invitation
  3. The invitation status has changed from PENDING to CLAIMED

This allows platforms to:

  • Track invitation usage and conversion rates
  • Trigger onboarding flows for new customers who joined via invitation
  • Apply referral bonuses or rewards to the inviter
  • Update their UI to reflect the claimed status

Authentication

The webhook includes a signature in the X-Grid-Signature header that allows you to verify that the webhook was sent by Grid. To verify the signature:

  1. Get the Grid public key provided to you during integration
  2. Decode the base64 signature from the header
  3. Create a SHA-256 hash of the request body
  4. Verify the signature using the public key and the hash

If the signature verification succeeds, the webhook is authentic. If not, it should be rejected.

postWebhookinvitation-claimed

Payload

idstring required

Unique identifier for this webhook delivery (can be used for idempotency)

type'INVITATION.CLAIMED' required

Type of webhook event in OBJECT.EVENT dot-notation. The part before the dot identifies the resource, the part after identifies the event. This lets consumers route purely on type without inspecting data.status.

timestampstring date-time required

ISO 8601 timestamp of when the webhook was sent

Example payload

{
  "id": "Webhook:019542f5-b3e7-1d02-0000-000000000007",
  "timestamp": "2025-08-15T14:32:00Z",
  "data": {
    "code": "019542f5",
    "createdAt": "2025-09-01T14:30:00Z",
    "claimedAt": "2025-09-01T14:30:00Z",
    "url": "https://uma.me/i/019542f5",
    "expiresAt": "2025-09-01T14:30:00Z",
    "inviterUma": "$inviter@uma.domain",
    "inviteeUma": "$invitee@uma.domain",
    "status": "PENDING",
    "firstName": "Jane",
    "amountToSend": {
      "amount": 12550,
      "currency": {
        "code": "USD",
        "name": "United States Dollar",
        "symbol": "$",
        "decimals": 2
      }
    }
  }
}

Response

Webhook received successfully