Add Jira webhooks

Webhooks notify external services about events that occur in P4 DAM. To learn more about webhooks, see Webhooks.

You can add webhooks that integrate P4 DAM with a Jira instance to share information between the applications. Jira webhooks can only be created at the company level, they cannot be created at the project level. After a P4 DAM company administrator adds a Jira webhook, P4 DAM users can add Jira work item links to assets. Basic information about the Jira work item and a link is displayed with the asset. When the asset is updated, the webhook runs and information is automatically sent and displayed in the related Jira work item.

You can also add custom webhooks to integrate P4 DAM with other external services. To learn more, see Add custom webhooks.

When webhooks run

Jira webhooks run when users:

  • Asset updated, which includes:

    • Adding new asset versions.

    • Moving assets.

    • Renaming assets.

    • Deleting assets.

  • Bundle content updated, which includes adding or excluding items, such as assets, folders, or other bundles, from a bundle. To manage the path rules for a bundle, see Manage items in an asset bundle.

  • Bundle review content updated, which includes adding or excluding items, such as assets, folders, or other bundles, from a bundle review. To manage the path rules for a bundle review, see Manage asset bundle review content.

  • Comment added to asset, bundle, or bundle review.

  • Link added to asset, bundle, or bundle review.

  • Review created.

  • Review deleted.

  • Review status updated: The webhook can run for all state changes, but it is restricted by the workflow transition rules it is added to. For example, if a transition rule allows a review state to change from Open to In progress and a webhook is part of the transition rule, the webhook only runs for that state change. To learn more, see Create company workflows.

Step 1: Configure a webhook

You must be a company administrator to work with webhooks at the company level.

  1. In P4 DAM, click your user avatar and click Company settings.

  2. From the Company settings pane, click Webhooks.

  3. On the Webhooks page, click Add webhook.

  4. On the Define details tab in the Add webhook pane, enter general information about the webhook.

    Field Description
    Name Enter a name for the webhook to distinguish it from other webhooks. For example, you might want to use the Jira project name to make it easily identifiable to users when they add Jira links to assets.
    Type From the Type dropdown, click Jira. To add a custom webhook that integrates with other external services, see Add custom webhooks.
    Projects By default, the webhook runs on all projects. To only run the webhook on specific projects, click the projects in the list. You can search for a project. To remove a project, click X next to it.
    Repositories/collections By default, the webhook runs on all collections in the projects. To only run the webhook on specific collections, click the collections in the list. You can search for a collection. To remove a collection, click X next to it.
    Events that trigger webhook By default, the webhook runs for all supported events for P4 DAM assets. To only run the webhook when specific events occur, click the events in the list. To remove an event, click X next to it.
    Interval Choose whether to run the webhook immediately after the event is performed or at a specified interval. An interval 5 minutes or more sends a batch of events that occur during the interval time.

  5. Click Continue.

  6. On the Configure webhook tab, enter the Jira URL, authentication parameters, and advanced options to customize the webhook.

    Field Description
    URL URL for the Jira instance to connect to from P4 DAM.
    Insecure SSL If the Jira instance uses an SSL/TLS certificate that cannot be verified, such as a self-signed certificate, click Insecure SSL.
    Authentication parameters Choose the authentication type to log in to the Jira instance and enter the credentials. The username associated with the credentials you enter is displayed in Jira comments as the user who performed an action in P4 DAM. You should use a Jira account that is not associated with a specific team member.

    • Jira Cloud - basic: Choose if your Jira instance is hosted in Jira Cloud. Enter the Jira Username and Access token to authenticate with Jira Cloud. Click to view the text of the access token you enter. To learn more about generating access tokens, see the Atlassian help topic Manage API tokens for your Atlassian account.

    • Jira Data Center - basic: Choose if your Jira instance is hosted in Jira Data Center and uses basic authentication. Enter the Username and Password to authenticate with Jira Data Center. Click to view the text of the password you enter.

    • Jira Data Center - bearer: Choose if your Jira instance is hosted in Jira Data Center and uses bearer authentication. Enter your Personal access token. Click to view the text of the access token you enter. To learn more about generating personal access tokens, see the Atlassian help topic Using Personal Access Tokens.
    Advanced settings Optional. Click the arrow to expand the area and set the options.

    • To override the default proxy configuration for the P4 DAM instance, click Use custom proxy configuration. Enter a custom proxy URL or leave the field empty if you do not want to use a proxy.

  7. Click Finish.

    The webhook is added. Users can now add Jira links in P4 DAM assets. To learn more, see Links.

    If you need to prevent the webhook from running temporarily, open the Webhooks pane, click the vertical ellipsis button for the webhook, and click Inactivate. The webhook is displayed as Inactive on the Webhooks pane. To learn more, see Manage webhooks.

    If you cannot save the webhook because P4 DAM cannot communicate with the Jira instance, see Troubleshoot Jira integration issues.