Webhooks
Invitation claimed webhook
Webhook that is called when an invitation is claimed by a user. This endpoint should be implemented by platform clients of the UMAaaS API.
When a user claims an invitation, this webhook is triggered to notify the platform that:
- The invitation has been successfully claimed
- The invitee UMA address is now associated with the invitation
- The invitation status has changed from PENDING to CLAIMED
This allows platforms to:
- Track invitation usage and conversion rates
- Trigger onboarding flows for new users 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-UMAaas-Signature header that allows you to verify that the webhook was sent by UMAaas. To verify the signature:
- Get the UMAaas public key provided to you during integration
- Decode the base64 signature from the header
- Create a SHA-256 hash of the request body
- 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
Example payload
{
"timestamp": "2023-08-15T14:32:00Z",
"webhookId": "Webhook:019542f5-b3e7-1d02-0000-000000000007",
"type": "INVITATION_CLAIMED",
"invitation": {
"code": "019542f5",
"createdAt": "2023-09-01T14:30:00Z",
"claimedAt": "2023-09-01T14:30:00Z",
"url": "https://uma.me/i/019542f5",
"expiresAt": "2023-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
}
},
"inviteeCountryCode": "US"
}
}Response
Webhook received successfully