Add webhook

In this guide, we will explain how to add a webhook properly within a project, some recommendations on how to supply it, and what to expect when implementing it.

Creating a webhook in Verifik

To add a webhook, we need to go to the settings section of webhooks. If we don't have any webhooks yet, we will find the following interface:

When we click on create, the following form will be displayed:

Here's an explanation of each parameter:

  • Name: Project name, it should be short and should not contain any special characters (?,ñ, ‘).

  • URL: Here you supply the URL to which Verifik will send events. It must be a real URL capable of receiving these types of events. It is recommended to have a developer or a development team to generate a suitable URL for this process.

  • Description: As the name suggests, here you add a description of the webhook. It is ideal to describe in which service or services it is used so that there is a proper mapping of where to expect the events that will be sent here.

Here's an example of how the form looks with the information supplied properly:

After generating the webhook, the interface will display the webhook like this, indicating that it is now possible to use this webhook for any Verifik project like SmartAccess.

Adding a webhook to a project

To add a webhook that we've already created to a project, we need to go to the project where we want to make this implementation.

Clicking on the edit button will take us to the section to connect the database.

When we get to the section to add a webhook, the one we just created will appear.

All that's left is to add the webhook that was just created and continue to save all changes.

You can also create a webhook directly from this view by clicking on the create webhook option. This will open a window that will take you to the settings section where this tutorial begins. If you create the webhook this way, you should use the reload button to see the webhook created correctly.

Last updated