Adding Jira webhooks for P4 DAM

  • Jira webhooks are only available for use with P4 DAM, not Perforce TeamHub.

  • Jira webhooks can only be added if P4 authentication is enabled for Perforce TeamHub.

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 issue links to assets. Basic information about the Jira issue 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 issue.

Jira webhooks run when users:

  • Update assets, which includes:

    • Adding new asset versions

    • Moving assets

    • Renaming assets

    • Deleting assets

  • Update the status of assets from the Open state to an In progress or Closed state type. The webhook will not run for any other asset status change. For example, the webhook will not run if you change the asset status from an In progress state to a Closed state type.

  • Add comments to assets.

  • Add links to assets or asset bundles.

  • Update asset bundles, which include adding or excluding items, such as assets, folders, or other asset bundles, from an asset bundle.

You can also add custom webhooks to integrate Perforce TeamHub with other external services. To learn more, see Adding custom webhooks.

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

  1. In Perforce TeamHub, go to the company to apply the webhook to. The webhook will be available for all projects in the company.

    When configuring webhooks in Perforce TeamHub, you will see references to repositories/collections. Perforce TeamHub stores files in repositories and P4 DAM stores assets in collections.

  2. Click Webhooks in the left navigation pane.
  3. On the Webhooks page, click Image of the Add button.

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

    Field Description
    Name Enter a name for the webhook to distinguish it from other webhooks. For example, you may want to use the Jira project name to make it easily identifiable to users when they add Jira links to assets.
    Type Only available if P4 Authentication is enabled for TeamHub. If the field is not available, you can only create custom webhooks. Select Jira. To add a custom webhook that integrates with other external services, see Adding custom webhooks.
    Projects By default, the webhook runs on all projects. To only run the webhook on specific projects, select the projects in the list. You can search for a project. To remove a selected project, click X next to it.
    Repositories/collections By default, the webhook runs on all collections in the selected projects. To only run the webhook on specific collections, select the collections in the list. You can search for a collection. To remove a selected 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, select the events in the list. To remove a selected event, click X next to it.
    Interval Select 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.
    Status To prevent the webhook from running, toggle the Status off. The webhook is displayed in gray on the Webhooks page. For example, you may want turn off a webhook a project phase is complete and no longer want P4 DAM to automatically update Jira with information.
  5. Click Next.

  6. On the Configure webhook tab, enter or select 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, select this option.
    Authentication parameters Select 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: Select 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: Select 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: Select 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, select 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 Save.

    The webhook is added. Users can now add Jira links in P4 DAM assets.

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