Signup Webhook

Automatically create contest entries from external signups

On this page

Signup Webhook

POST/api/webhooks/signup/:contestId
Webhook Secret

Receive signup events from your application or third-party services to automatically create contest entries.

Endpoint

POST https://blitzrocket.com/api/webhooks/signup/:contestId

Path Parameters

contestIdstring required

The unique contest identifier

Request Body

emailstring required

Email address of the new signup

namestring

Name of the new signup (optional)

phonestring

Phone number (optional)

referralCodestring

Referral code if the signup was referred (optional)

Request

curl -X POST https://blitzrocket.com/api/webhooks/signup/clx1abc123 \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "name": "New User"
  }'

const contestId = "clx1abc123";
const response = await fetch(
  `https://blitzrocket.com/api/webhooks/signup/${contestId}`,
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      email: "[email protected]",
      name: "New User",
    }),
  }
);

const data = await response.json();
console.log(data);

import requests

contest_id = "clx1abc123"
response = requests.post(
    f"https://blitzrocket.com/api/webhooks/signup/{contest_id}",
    json={
        "email": "[email protected]",
        "name": "New User"
    }
)

data = response.json()
print(data)

Response

{
  "success": true,
  "data": {
    "entryId": "entry_new789",
    "email": "[email protected]",
    "alreadyExists": false,
    "isReferred": false,
    "pointsAwarded": {
      "advocate": 0,
      "friend": 0
    }
  }
}

Setup Guide

  1. Navigate to your contest's Design page in the Blitz Rocket dashboard
  2. Enable External Tracking in the contest settings
  3. Copy your webhook URL: https://blitzrocket.com/api/webhooks/signup/{your-contest-id}
  4. Configure your external platform to send POST requests to this URL on signup events

Integration Examples

Shopify Customer Creation

Configure a Shopify webhook to fire on customers/create:

// Shopify sends this payload automatically:
{
  "email": "[email protected]",
  "first_name": "Jane",
  "last_name": "Doe"
}

Custom Sign-up Form

document.querySelector("#signup-form").addEventListener("submit", async (e) => {
  e.preventDefault();

  const form = new FormData(e.target);
  const email = form.get("email");
  const name = form.get("name");

  // First, register in your system
  await registerUser({ email, name });

  // Then, create contest entry via webhook
  await fetch(
    `https://blitzrocket.com/api/webhooks/signup/${CONTEST_ID}`,
    {
      method: "POST",
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify({ email, name }),
    }
  );
});