Webhooks

Webhooks can be used only with SO or ASN integrations!

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. Inform the Payload URL to Jakamo support for the required firewall openings.
Authentication	Select the authentication method. OAuth2 is recommended if your endpoint supports it. Basic auth is another common option. Other methods are for special purposes — if required, Jakamo support will guide you.
Integration	(Optional) Ties the webhook to a specific SO integration. Only appears when your company has an SO integration designated as the webhook integration. See Webhook Integration below.
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.

Webhook Integration

When a company has multiple SO (sales order) integrations, one of them can be designated as the webhook integration. This determines which integration identity is used when Jakamo sends outbound webhook messages for sales order events.

Designating a webhook integration is optional, but highly recommended when you have more than one SO integration — it is the prerequisite for being able to tie a webhook to a specific integration. Without a designated webhook integration, the Integration field will not appear in the webhook form, and the webhook will be triggered by events from any SO integration.

How to set a webhook integration:

The webhook integration is configured by Jakamo support or administrators via the integration's Settings dialog in the admin panel. Contact Jakamo support to have a webhook integration designated for your SO integration. The currently active webhook integration is shown with a Webhook integration badge on your Integrations settings page.

Once a webhook integration is set, the Integration field appears in the webhook form, letting you tie a specific webhook to that integration.

note

• No integration selected: The webhook will be triggered by events from any SO integration. This is fine when you only have one SO integration, but with multiple integrations it is strongly recommended to select one explicitly.
• Only the currently designated webhook integration can be selected when creating or editing a webhook.
• If the webhook integration is changed, existing webhooks that were tied to the previous integration will retain that link. They can still be saved as-is, but the old integration cannot be re-selected once cleared.
• If no webhook integration is designated, the Integration field will not appear in the webhook form.

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 Send to create the webhook.
• To modify an existing webhook, click Edit on the webhook row, make your changes, and click Send again.
• A webhook that has already sent messages cannot be deleted. If you need to stop it from triggering, disable it using the Webhook enabled checkbox instead.

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

Help & Support

Didn't you find what you were looking for? Send email to Jakamo support (support@thejakamo.com) and we will help you.