Webhooks allow you to connect external apps and automations to External User Manager and retrieve information related to specific actions occurring within the app.
For instance, you can choose to trigger the Webhook when a Guest Request is created, which will transmit the corresponding details to your app/automation, triggering a script that would send the details to a separate database for further processing.
This is a relatively rudimentary example; in real-world scenarios, this feature could be used in a variety of different ways depending on your level of imagination and coding prowess.
Let's go through the Webhook setup and utilization process to better understand what can be gained by using them.
🪝 Webhook Setup
Navigate to Settings > Expert mode > Connected apps > Webhooks to get started.
Click on + Add webhook.
Specify the Webhook Name and Description.
Select a Trigger event from the list. This is the action performed within External User Manager that will prompt the system to send out the necessary information. In our case, the Request will be triggered by the the Creation of a New Guest Request.
Choose your platform of choice, it could be either Power Automate, an Azure Function, or HTTP.
Paste the URL for your platform of choice into the corresponding field.
Click Save.
Copy the Secret to authenticate future Requests.
Once created, Webhooks can be Edited or Deleted by clicking on the corresponding buttons next to the desired entry on the list. You can also Rotate the Webhook Secret here.
🏅 Final Results
Once the Trigger Action is performed within External User Manager, you'll receive all of the expected information on your platform of choice.
In our case, we received the Requester, Invitee, Onboarding State, Creation Date, Metafield Data, Tenant ID, and the Trigger Event for our new Guest Request.
⛑️ Need more help?
Get further assistance with External User Manager through our support chat widget within the app, or reach out to us at [email protected]