Add P4 Plan webhooks

You can add webhooks that integrate P4 Plan with P4 DAM to share information between the applications.

After a P4 DAM company administrator adds a P4 Plan webhook, P4 DAM users can add P4 Plan item links to assets. Basic information about the P4 Plan 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 P4 Plan item as a comment. To learn more about webhooks, see Webhooks.

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

P4 Plan webhooks can only be created at the company level, they cannot be created at the project level. You must be a company administrator to work with webhooks at the company level.

Version requirements

The P4 Plan webhooks integration requires:

P4 Plan Server 2024.2/010 and later
P4 Plan Web 2024.2/003 and later.

When webhooks run

P4 Plan 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. See Create company workflows. 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. To manage the path rules for an asset bundle, see Manage items in an asset bundle.

Step 1: Create an integration user

Before integrating P4 Plan with P4 DAM, create an integration user and assign it as the main manager in the required projects in P4 Plan.

Create an integration user in P4 Plan.

To create a user in P4 Plan, see Adding a team member to P4 Plan in the P4 Plan documentation.
Set the user settings to Is a main manager to allow the webhook integration user to perform actions such as accessing projects, searching for items, and adding comments.

To change user settings in P4 Plan, see Changing project user settings in the P4 Plan documentation.

Step 2: Configure a webhook

In P4 DAM, click your user avatar and select Company settings.
From the Company settings pane, click Webhooks.
On the Webhooks page, click Add webhook.

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 P4 Plan to make it easily identifiable to users when they add links to assets.
Type	Select P4 Plan. 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, 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.

Click Continue.

On the Configure webhook tab, enter or select the P4 Plan URL, authentication parameters, and advanced options to customize the webhook.

Field	Description
URL	Web client URL for P4 Plan to connect to P4 DAM.
Insecure SSL	If P4 Plan uses an SSL/TLS certificate that cannot be verified, such as a self-signed certificate, select this option.
Authentication parameters	Authenticate to P4 Plan using a username and either a token or a password. A token is valid for two years, but you can change the expiration date. To use a P4 Plan token, see Adding authentication tokens in the P4 Plan documentation. A password is valid for one hour.
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. To restrict when webhooks run based on path or reference patterns, see Restrict when webhooks run (Optional).

Click Finish.
The webhook is added. Users can now add P4 Plan links to P4 DAM assets. To learn more, see Work with links on assets.
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 P4 Plan, see Troubleshoot P4 Plan integration issues.