Webhooks
Webhooks can be used only with Sales Order integration and ASN integration.
From this page, find instructions on how to create a webhook in Jakamo.
1. Setup Integration Mappings
Configure all user and company mappings normally. Follow mapping instructions.
2. Configure Webhook in Jakamo Integrations Settings
Navigate to the Integrations settings page in Jakamo and select Webhooks from the top of the page. Create and configure a new webhook by filling in the requested information.
| Field | Description |
|---|---|
| Webhook name | Give the webhook a descriptive name. |
| Payload URL | Enter the server address (endpoint) where the webhook will send messages. |
| Authentication | Select the authentication method. Use Basic Auth with a username and password. These credentials must match what is configured on the receiving server. |
| Remove entry from queue on success ** | Enable this checkbox. If the receiving server responds with status code 200, 201, or 204, the message will be removed from Jakamo’s API queue. If not enabled, removal follows the normal queue handling process. |
| Disable Automatic Retry (if available for the event type) | Enable during testing, disable in production. If enabled, the webhook will retry delivery based on a predefined schedule. Automatic retry is only available for Sales order created events. If disabled, manual resend required. |
** Remove entry from queue on success: For events connected to items in the process queue, delete the item in the queue when the webhook was successful. Successfull HTTP response codes are:
- 200 OK
- 201 Created
- 204 No Content
If the response is 202 Accepted or any other status code, it is the responsibility of the customer’s integration endpoint to remove the item from the queue.
3. Events Triggering the Webhook
- Recommended: Selected Events allows to define separately with which event types webhooks is used.
- If choosing All Events, make sure to understand each event type (PO, SO and ASN events).
4. Create the Webhook
- Click
Sendto create the webhook. - Note: Editing is not supported, but you can delete and recreate the webhook if needed.
5. Webhook Transport Logs
- Request Payload shows the actual message sent: request headers and request payload (for example, order message)
- View responses from the receiving server: response code, response body and additional messages
Didn't you find what you were looking for? Send email to Jakamo support (support@thejakamo.com) and we will help you.