››

How to Use the REST API Integration in ProProfs WebinarNinja

The REST API integration in ProProfs WebinarNinja lets you connect your webinars to external applications and systems. Using the API, you can automatically register attendees, retrieve registration data, and keep your webinar workflows in sync with other tools.

This integration is ideal for teams that use custom applications, internal systems, or third-party platforms that rely on API-based communication.

Benefits:

External System Integration: Register users from your own applications, landing pages, or internal tools without relying on built-in forms.
Controlled Registration Triggers: Automatically register users based on actions such as form submissions, purchases, or internal approvals.
Advanced Workflow Support: Build custom workflows using the API, including multi-step or conditional registrations.

Example:

A SaaS company runs paid webinars and confirms access only after payment is completed. Once the payment system verifies the transaction, it sends the attendee’s details to WebinarNinja through the REST API. The attendee is registered only after successful payment, ensuring that access is granted correctly and the registration list stays accurate without manual checks.

Steps to Access and Use the REST API Integration

Step 1: Go to Integrations

From your ProProfs WebinarNinja dashboard, click Integrations.

Step 2: Open REST API

On the Integrations page, locate REST API and click Manage to open the REST API documentation screen.

Step 3: Locate the “Register a User to a Webinar” API

On the REST API screen, you will see the section titled Register a User to a Webinar. This section provides all the details required to register a user for a webinar using the REST API.

Step 4: Note the API Endpoint

Under Endpoint, copy the following URL:

POST https://my.webinarninja.com/api/v1/open/registrants

This endpoint is used to send webinar registration requests from your external system.

Step 5: Add Authentication Query Parameters

Under Authentication (Query Parameters), include the following required parameters in every API request:

api_key: Your WebinarNinja API key
account_email: The email address associated with your WebinarNinja account

These parameters authenticate the request and link it to your account.

Step 6: Set the Request Header

Under Headers, set the following header:

Content-Type: application/json

This ensures the request body is processed correctly.

Step 7: Prepare the Request Body

Under Request Body, include the webinar and attendee details in JSON format. For example:

{

"webinar_registration_url": "https://your-subdomain.webinarninja.com/live-webinars/12345/register",

"email": "user@example.com",

"name": "John Doe"

}

Make sure the following fields are included:

webinar_registration_url
email
name

Step 8: Send the API Request

Send the POST request from your external application or system using the endpoint, authentication parameters, headers, and request body.

Once the request is successful:

The user is registered for the webinar
The registrant appears in the webinar’s Registration List
The user is included in webinar notifications and follow-ups

Step 9: Test the Integration

Before using the API in a live workflow, send a test request with sample data and verify that the registrant appears correctly in WebinarNinja.

That’s all about using the REST API Integration in ProProfs WebinarNinja. Please contact our support team if you encounter any issues or questions.