Skip to main content
WEBHOOK
registrationForOnDemand
{
  "action": "REGISTRATION_FOR_ON_DEMAND",
  "actionId": "a912a64f-8865-4289-9024-9a120792c3d8",
  "actor": {
    "id": "h212a64f-8865-4289-9024-9a120792c3d8",
    "type": "USER"
  },
  "actionCreatedAt": "2023-10-01T12:00:00Z",
  "registration": {
    "id": "d5e31ba5-2d1e-4918-bb60-dd1514b4b397",
    "profile": {
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com",
      "company": "Zuddl",
      "designation": "Senior Software Engineer",
      "bio": "Jane is a senior engineer with over 10 years of experience in cloud architecture.",
      "headline": "Cloud Architecture Expert | Tech Speaker",
      "industry": "Information Technology",
      "country": "United States",
      "phoneNumber": "+1-2125551234"
    },
    "customFieldsData": [
      {
        "fieldSlug": "city1",
        "value": "New York City"
      }
    ],
    "disclaimers": [
      {
        "text": "<p>I agree to the terms and conditions</p>",
        "consentGiven": true
      }
    ],
    "source": {
      "flowId": "d5e31ba5-2d1e-4918-bb60-dd1514b4b397",
      "type": "ZUDDL_API",
      "referrer": "https://site.zuddl.com/landing-page",
      "utmParams": {
        "id": "123456",
        "source": "newsletter",
        "medium": "email",
        "campaign": "march_promo",
        "term": "newsletter",
        "content": "newsletter"
      },
      "metadata": {
        "key": "value"
      }
    },
    "attendanceType": "VIRTUAL",
    "eventId": "d812a64f-8865-4289-9024-9a120792c3d8",
    "socialLinks": {
      "linkedin": "https://www.linkedin.com/company/zuddl",
      "twitter": "https://x.com/wearezuddl",
      "instagram": "https://www.instagram.com/wearezuddl",
      "facebook": "https://facebook.com/zuddl",
      "website": "https://www.zuddl.com"
    },
    "ticketDetails": {
      "ticketTypeId": "f6b8cf1f-64e5-4801-935c-f6398bb111cd",
      "ticketName": "VIP Pass",
      "addOns": [
        {
          "id": "67f6ccf5-4c3d-4fed-bcca-822e3c3cf25a",
          "name": "Advanced Workshop",
          "sessions": [
            {
              "id": "<any>",
              "name": "<any>"
            }
          ]
        }
      ],
      "flowSubContextId": "<string>"
    },
    "oldTicketDetails": {
      "ticketTypeId": "f6b8cf1f-64e5-4801-935c-f6398bb111cd",
      "ticketName": "VIP Pass",
      "addOns": [
        {
          "id": "67f6ccf5-4c3d-4fed-bcca-822e3c3cf25a",
          "name": "Advanced Workshop",
          "sessions": [
            {
              "id": "<any>",
              "name": "<any>"
            }
          ]
        }
      ],
      "flowSubContextId": "<string>"
    },
    "qrCodeImgUrl": "https://cdn.zuddl.com/qrcodes/atnd_12345abcde.png",
    "magicLinkUrl": "https://event.zuddl.com/magic-link/abcdef123456",
    "confirmationCode": "01U6K9",
    "status": "REGISTERED",
    "statusUpdatedAt": "2025-04-07T09:57:55.71874Z",
    "statusSource": "MANUAL_UPDATE",
    "roles": [
      "ATTENDEE",
      "SPEAKER"
    ],
    "unsubscribedNotificationDetails": [
      {
        "unsubscribeReason": "unsubscribeReasonExample",
        "categoryName": "PROMOTIONAL"
      }
    ],
    "createdAt": "2025-04-07T09:57:55.826749Z",
    "createdBy": "a412e3d2-e15e-4fe0-bf35-7fcfb235a4b2",
    "updatedAt": "2025-04-07T09:57:56.045946Z",
    "profilePictureUrl": "https://cdn.zuddl.com/attendees/atnd_12345abcde/profile.jpg"
  },
  "event": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Huddle with zuddl.",
    "description": "join us to learn more about zuddl.",
    "identifier": "event-123",
    "startDate": "2025-04-11T12:30:00Z",
    "endDate": "2025-04-11T12:30:00Z",
    "timezone": "UTC/IST",
    "status": "UPCOMING/ONGOING",
    "type": "WEBINAR/FIELD_EVENT/EVENT",
    "eventFormat": "VIRTUAL/IN_PERSON/HYBRID",
    "createdAt": "2025-04-11T12:30:00Z",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedAt": "2025-04-11T12:30:00Z",
    "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customProperties": [
      {
        "key": "salesforceCampaignId",
        "value": "ABCyyZ1234"
      }
    ]
  }
}

Headers

X-Webhook-Signature
string
required

Signature to verify the webhook request

Body

application/json

Information about registered activity

Webhook payload for registration for on demand activity

action
enum<string>
Available options:
REGISTERED,
REGISTRATION_FOR_ON_DEMAND,
ATTENDED,
ATTENDED_ON_DEMAND,
ENTERED,
REGISTRATION_DATA_MODIFIED,
REGISTRATION_DELETE,
TICKET_MODIFIED,
UNASSIGNED_TICKET,
TICKET_TRANSFERRED,
ADD_ON_MODIFIED,
COUPON_CODE_MODIFIED,
INVITED,
INVITE_DECLINED,
REGISTRATION_ATTEMPTED,
REGISTRATION_ABANDONED,
ASSIGNED_NOT_REGISTERED,
REGISTRATION_PENDING_APPROVAL,
REGISTRATION_REJECTED,
APPROVED_NOT_REGISTERED,
APPROVED,
ANSWERED_POLL,
ASKED_QUESTION,
QUESTION_UPVOTED,
ANSWERED_SURVEY,
CTA_CLICKED,
JOINED_SESSION,
JOINED_BREAKOUT_ROOM,
JOINED_BOOTH,
JOINED_DISCUSSION_ROOM,
EVENT_CREATED,
EVENT_ADDED_IN_SERIES,
EVENT_ADDED_IN_HUB,
EVENT_UPDATED,
LEAD_ADDED,
LEAD_CAPTURE_FIELDS_DATA_MODIFIED,
LEAD_ENRICHMENT,
SESSION_REGISTRATION,
TIME_SPENT_IN_EVENT,
TIME_SPENT_IN_BOOTH,
TIME_SPENT_IN_DISCUSSION_ROOM,
TIME_SPENT_IN_SESSION,
NO_SHOW,
AGGREGATED_TIME_SPENT_IN_BOOTH,
AGGREGATED_TIME_SPENT_IN_DISCUSSION_ROOM,
AGGREGATED_TIME_SPENT_IN_SESSION,
WATCHED_VOD,
ON_DEMAND_SETTING_UPDATED,
AGGREGATED_POLL_ANSWERED,
AGGREGATED_QUESTION_ASKED,
AGGREGATED_QUESTION_UPVOTED,
AGGREGATED_SURVEY_ANSWERED,
AGGREGATED_CTA_CLICKED,
AGGREGATED_WATCHED_VOD,
AGGREGATED_JOINED_BREAKOUT_ROOM
Example:

"REGISTRATION_FOR_ON_DEMAND"

actionId
string<uuid>

Unique identifier of the action triggered in zuddl.

Example:

"a912a64f-8865-4289-9024-9a120792c3d8"

actor
object

Details of the actor who performed the action.

actionCreatedAt
string<date-time>

Timestamp when the action was created.

Example:

"2023-10-01T12:00:00Z"

registration
object
event
object

Response

200

Return a 200 status to indicate that the data was received successfully

I