Create gifts by webhook (coming soon)

curl --request POST \ --url https://api.snappy.com/public-api/v2/webhooks/send-gifts \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: <api-key>' \ --data ' { "Business Email": "john.doe@example.com", "First Name": "John", "Last Name": "Doe", "Company Name": "Example Inc." } '

{ "message": "Gifts created successfully", "results": [ { "success": true, "link": "https://snappy.com/12345678/abc123", "id": "abcDEF12", "experienceId": "1234wxyz" }, { "success": false, "message": "Recipient with id def456 already exists", "errorCode": 10001 } ] }

Authorizations

X-Api-Key

string

header

required

Company Level Authentication

Company level authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients.

Getting Your API Key

Create an API Key: Use the POST /v2/authentication/apiKeys endpoint to generate a new API key
Set Expiration: Choose from 30, 60, 90, or 180 days (default: 90 days)
Optional mTLS: Enable mutual TLS for enhanced security
Name Your Key: Provide a descriptive name for easy identification

Using Your API Key

Include your API key in the X-Api-Key header for every request:

X-Api-Key: YOUR_24_CHARACTER_API_KEY

API Key Management

Maximum Keys: Up to 3 active API keys per company
Rotation: Delete old keys before creating new ones when at the limit
Security: Keys are hashed and cannot be retrieved after creation

Enhanced Security (mTLS)

For production environments, enable mutual TLS authentication:

Set enforceMtls: true when creating the API key
Contact support to obtain your client certificates
Use the mTLS endpoint: https://mtls-api.snappy.com/public-api

Query Parameters

companyId

string

required

Company ID

Pattern: ^[A-Za-z0-9]{8,}$

Example:

"12345678"

apiKey

string

required

Your API Key

Example:

"api_key"

campaignId

string

required

Campaign ID

Pattern: ^[A-Za-z0-9]{8,}$

Example:

"abcd1234"

collectionId

string

default:6d8Bck6wYy

Collection ID

Example:

"abcdef12"

budgetMax

number

default:50

Maximum budget for the gift

Required range: 1 <= x <= 10000

Example:

100

budgetMin

number

default:35

Minimum budget for the gift

Required range: 1 <= x <= 10000

Example:

76

Body

application/json

Webhook request body for creating gifts.

Business Email

string<email>

required

The business email of the recipient

Example:

"john.doe@example.com"

First Name

string

required

The first name of the recipient

Example:

"John"

Last Name

string

required

The last name of the recipient

Example:

"Doe"

Company Name

string

required

The company name of the recipient

Example:

"Example Inc."

{key}

unknown

Response

200 - application/json

Response for webhook gift creation.

message

string

required

The message of the response

results

object[]

The results of the gift creation

Show child attributes