Using webhooks

Webhooks notify external applications and services about actions that occur in Helix DAM.

You can add webhooks to integrate Jira with Helix DAM or custom webhooks to integrate with other external services.

Helix DAM company and project administrators add and manage webhooks in the Helix TeamHub web interface.

Jira webhooks

Jira webhooks integrate Helix DAM with a Jira instance for information sharing between the applications. After an administrator adds a Jira webhook, users can select the webhook that connects to the Jira instance when they add links to assets. Basic information about and a link to the Jira issue are displayed with the asset. When the asset is updated, the status changes, or a comment is added, information is automatically sent to Jira and displayed in the related Jira issue as a comment.

By default, Jira webhooks run when users perform the following actions in Helix DAM:

  • Update assets, which includes:

    • Adding new asset versions

    • Moving assets

    • Renaming assets

    • Deleting assets

  • Update the status of assets

  • Add comments to assets

To learn more about adding Jira webhooks, see Adding Jira webhooks.

Custom webhooks

Custom webhooks integrate Helix DAM and Helix TeamHub with external services.

For example, Helix DAM may not support previews for asset types your team works with. To add asset previews for these file types, you can use a webhook to communicate with an external service to automatically generate previews for the assets. Then, the previews can be added to the appropriate assets in Helix DAM.

When a custom webhook runs, Helix DAM sends an HTTP post request with a JSON payload to the specified endpoint URL. You can use any endpoint that can process the request.

Custom webhooks run when users perform the following actions in Helix DAM:

  • Add new assets and new asset versions

  • Move assets

  • Rename assets

  • Delete assets

You can add custom webhooks at the company or project level.

  • Webhooks added at the company level can run on collections in multiple Helix DAM projects. Company admins can configure webhooks at the company level.

  • Webhooks added at the project level only run on collections for the selected Helix DAM project. Company admins and project admins can configure webhooks at the project level.

To learn more about adding custom webhooks, see Adding custom webhooks.