1. What are Webhooks?
Webhooks are a simple and automatic way to receive real-time information whenever an event occurs in Modjo.
Instead of constantly checking for updates, Modjo sends the information directly as soon as an event happens.
With webhooks, you can connect Modjo to other tools and automate tasks without manual intervention. This saves time, improves collaboration, and ensures that all information stays up to date in your preferred tools.
Example:
Receiving an Alert in Slack
Imagine your team uses Slack for communication. With webhooks, you can set up an automatic alert that sends a message to a Slack channel.
This keeps the entire team informed in real time, allows for quick reactions, and ensures better customer follow-up with no extra effort.
This feature is particularly useful for:
Syncing data
Automating workflows
Integrating Modjo with third-party tools
2. How to set Up Webhooks
🚨 Prerequisites : Before creating a webhook, you must have Administrator or Manager permissions.
Steps to Create a Webhook
Click "Create Webhook" and enter the URL where you want to receive webhook notifications.
Once created, you will receive a unique security token. This token will be used to verify incoming webhook requests and ensure they are genuinely sent by Modjo.
3. Securing your Webhook endpoint
Since webhooks send data to the specified URL, it’s crucial to carefully select and secure the endpoint that will receive this information.
Best practices for Webhook security :
Use HTTPS: Always provide a secure HTTPS endpoint to encrypt data in transit.
Ensure the URL is accessible: The system receiving the webhook must be reachable from the internet. If you’re testing locally, consider using tools like ngrok to expose your local server.
Do not expose sensitive endpoints: The webhook URL should be dedicated to receiving webhooks and should not be accessible by unauthorized users.
Validate incoming requests: You should verify the webhook signature using the security token provided when you created the webhook. This ensures the requests are truly coming from Modjo.
Be aware of the data being sent: Webhooks may contain sensitive business data, so avoid using publicly accessible endpoints where unauthorized parties might intercept the information.
4. Managing Webhooks
You can edit or delete your webhooks at any time from the Webhook settings page.
If you no longer need a webhook, we strongly recommend deleting it to prevent unnecessary requests.
If you suspect unauthorized access, you should recreate the webhook to generate a new security token.
For details on:
Different webhook events
Handling webhook requests
Verifying their authenticity
Please refer to the Modjo API Documentation.