Momentus Connect provides a built-in webhook management interface, allowing you to configure and manage webhooks across your Momentus products. Webhooks enable your external systems to receive real-time notifications when specific events occur in Enterprise or Elite.
To access the webhook management page, go to Momentus Connect. In the header, go to APIs > Webhooks. On this page you can view all configured webhooks and see the following information for each:
- Name: the unique identifier for the webhook
- Trigger Action: the event that fires the webhook
- Endpoint: the callback URL where the webhook notification is sent
- Status: whether the webhook is Active or Inactive
- Actions: management actions available for each webhook (covered below)
To view additional information, click the three dots icon on the far right of a webhook's row and select View Details Page.
In this article:
Add a Webhook
Webhooks are added on the webhook management page. To create a webhook:
- Click Create Webhook. The Create Webhook page opens.
- Add Application information:
- Application: The Momentus product the webhook applies to, either Enterprise or Elite. This field is filled automatically based on the product you accessed Momentus Connect from.
- Trigger Action: Choose the action that causes the webhook to initiate.
- Webhook Name: Add a unique name for the webhook.
- Web Service URL: Add the callback URL, the endpoint that handles the HTTP POST request when the Trigger Action occurs. Use secure URLs (https) for production environments.
- Add Authentication information:
- Authentication Method: Currently, only OAuth is supported.
- Timeout: How long the software waits for the receiver’s response before terminating the connection. The default is 15 seconds, but you can increase this based on your requirements.
- Secret Key: A unique key the custom web service uses to authenticate the request it receives. This is auto-generated with random values, but you can replace it with your own.
- Set as Asynchronous:
- If selected, the webhook is asynchronous and does not block business processing.
- If not selected, the webhook is synchronous and blocks business processing until a response is returned.
- Ignore for API:
- If selected, the webhook is not initiated as a result of API calls. This is particularly useful to avoid endless loops. For example, if you configure a webhook for Account Update and your webhook handler calls the Accounts API endpoint, that would re-trigger the webhook indefinitely. Enabling Ignore for API prevents this.
- If not selected, the webhook will be triggered by API calls.
- Active: Only active webhooks are triggered. Uncheck this to create the webhook in an inactive state.
- Click Save.
Edit a Webhook
To edit a webhook:
- On the webhook management page, click the three dots icon on the far right of a webhook's row and select Edit Webhook. The Edit Webhook page opens.
- Update details as needed. The webhook's Application and Authentication Method cannot be edited.
- Click Save.
Inactivate a Webhook
To temporarily stop a webhook from triggering, you can inactivate it. To inactivate a webhook:
- On the webhook management page, click the three dots icon on the far right of a webhook's row and select Edit Webhook. The Edit Webhook page opens.
- Uncheck Active.
- Click Save.
Delete a Webhook
If a webhook is no longer needed, you can delete it. There is no confirmation step, so take care before using this action!
To delete a webhook:
- On the webhook management page and click the three dots icon on the far right of a webhook's row.
- Select Delete Webhook. The webhook is deleted.