Using The Webhooks Notifications

What are Webhooks?

Webhooks are like digital messengers that help different apps and systems talk to each other. They work behind the scenes to share information between different websites, services, or software without doing anything manually.

What Are They Used For?

Think of webhooks as notifications that let one app tell another app when something important happens. For example, if some order has been created, the store's app might use a webhook to let the shipping company's app know that there's a new order to deliver. This helps things happen smoothly without you having to track everything yourself.

In simpler words, webhooks are like friendly little helpers that make sure all your apps work together and share updates automatically.

Webhook Notifications in Common Ninja?

At Common Ninja, webhook notifications enable posting the submission's data after specific widget events, such as user-submitted forms for example. 

This feature is found in widgets like forms, scratch cards, comments, and more.

Activating webhook notifications is a two-step process:

1.  Preparing Your Webhook Website

Before activating the webhook notifications feature on the widget, set up a webhook website that can receive the data you send to it.

2. Enabling Webhook Notifications:

In the widget editor, navigate to the “Notifications” tab.

Enable the “Webhooks” option.

After enabling, paste the URL of your webhook website into the “Endpoint” field.

3. Choosing Payload Format:

Directly beneath the "Endpoint" field, you'll find the "Payload Format" field. Here, you can select whether your data will be displayed as an array of objects or as a simple array. A detailed explanation of both structures is provided in the continuation of this article.

And that's it! Using this setup, each time a user submits your widget, the webhook website will receive the submission's data.

Note that the submission data will display differently depending on the chosen payload format:

Array: will display as an array of objects, each containing:

• The widget’s field ID
• The field's name
• The user submission value

Object: will display as a single object containing all fields and their values.