Warning: This feature is primarily meant for advanced users and developers!
Webhooks are a lightweight API that allows for one-way data sharing triggered by events. In other words, you can send data somewhere based on some specific event happening.
In our platform's case, we support sending registrant data somewhere after an event registration and after the actual event (immediately after, 1 day after, 2 days after, and 3 days after).
In order to get started, you'll need to have an application or server URL that can receive data from WebinarKit. Add that link inside your webinar settings (on the "Other" settings page) under the "Webhooks" section.
We send data in a POST request. The request payload uses the JSON format and includes the following information:
{ email: 'example@email.com', first: 'Joe', last: 'Schmo', phoneCountryCode: '+1', phone: '123456789', customField1: 'Custom field 1', customField2: 'Custom field 2', customField3: 'Custom field 3', customField4: 'Custom field 4', customField5: 'Custom field 5', url: 'https://mycustomdomain.com/webinar/thankyou/12345',
replay_url: 'https://mycustomdomain.com/replay/12345', date: 'Wednesday, June 22nd at 10:45 PM ET'
date_iso: '2023-02-16T22:50:16.157Z',
date_timestamp: 1676588668686,
date_h_timestamp: '2023 02 16 10:50 PM'}
Also, we pass any URL parameters that were appended to the registration page link. This can be useful, for example, in passing things like UTM parameters to 3rd party applications. Each key value pair in the URL parameters will be added as its own key value pair in the POST request body shown above.