Add custom webhooks

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

You can create custom webhooks to configure P4 DAM to send an HTTP post request with a JSON payload to the specified endpoint URL. You can use any endpoint that can process the request. To learn more about the required payload format and examples for webhooks, see Custom webhook JSON payload format and examples.

Custom webhooks run when users perform any of the following actions in P4 DAM:

  • Asset updated, which includes:
    • Adding new asset versions.
    • Moving assets.
    • Renaming assets.
    • Deleting assets.

  • 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.

You can also add Jira webhooks to integrate P4 DAM with Jira. To learn more, see Add Jira webhooks.

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

  1. In P4 DAM, do one of the following:

    • To add a webhook that runs on multiple P4 DAM projects, add the webhook at the company level. Click your user avatar and click Company settings. The Company settings pane opens.

    • To add a webhook that runs on a specific P4 DAM project, go to the project. In the pane on the left side of the page, at the bottom, click Project settings. The Project settings pane opens.

  2. Click Webhooks.

  3. On the Webhooks pane, click Add webhook.

  4. In the Add webhook pane, on the Define details tab, enter information about the custom webhook.

    Field Description
    Name Enter a unique name for the webhook.
    Type From the Type dropdown, click Custom. To add a webhook that integrates P4 DAM with Jira, see Add Jira webhooks.
    Projects Only available when creating a webhook at the company level. By default, the webhook runs on all projects. To run the webhook only 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. Those projects are gray in the list. To run the webhook on other collections in other projects, 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 of 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 webhook URL, header information, and advanced options to customize the webhook.

    Field Description
    URL URL of the endpoint the payload is delivered to.
    Insecure SSL If the endpoint uses an SSL/TLS certificate that cannot be verified, such as a self-signed certificate, click Insecure SSL.
    Authentication headers Authentication information to send in the request. Authentication headers ensure that incoming requests are from a trusted source. The authentication method and header format varies depending on the external service you are working with. To learn more about specific authentication methods and header requirements, see the documentation for the service or application you are integrating with.

    Example authentication headers commonly used in webhook implementations:
    Authorization: ApiKey API_KEY_VALUE
    x-api-key: <api-key>

    To add more than one authentication header, click Add header and then enter the additional header information.
    Custom headers Describes the request, such as the type of data. You can create custom headers for any purpose.

    To add more than one header, click Add header and then enter the additional header information.
    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 box empty if you do not want to use a proxy.

    • To restrict when webhooks run based on reference or path patterns, see Restrict when webhooks run (Optional).

  7. Click Finish to save the webhook.

    The webhook is added.

    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.