Skip to content

Commit 3afa093

Browse files
DOCS-738 new webhooks permission setting (#291)
* Updating webhooks guide to cover new permissions setting * minor re-wording for consistency
1 parent cfa9c47 commit 3afa093

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

webhooks/webhooks.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,21 @@ The event object identifies the resource that changed, the type of change, a tim
3434
- For Creates and Updates, the Resource name and ID are contained in the event object.
3535
The web service can then send a GET request back to the Procore API to gather information about the specified resource that changed.
3636

37+
## Setting Required Permissions for Webhooks
38+
39+
When building applications that leverage the Webhooks feature, it is important to set the proper permissions in your data connector component.
40+
The required permission level for Webhooks API is 'Standard'.
41+
Note that by default, the Webhooks API permission is set to 'None' in a data connector component.
42+
In order for your application to function properly, you will need to use the Configuration Builder to set the Webhooks API permission to 'Standard'.
43+
For more information on configuring permissions on data connector components using the Configuration Builder, see [Building Procore Data Connection Applications with DMSA](/documentation/).
44+
3745
## Using a Developer Managed Service Account (DMSA) with the Webhooks Feature
3846

3947
We recommend using a Developer Managed Service Account (DMSA) for authenticating GET requests back to the Procore API when gathering information about resources that have changed.
4048
DMSAs are the preferred authentication method for data connection applications and allow you to specify the exact company and project level tool permissions that are required for your application to run properly on the Procore platform.
4149
Using a DMSA alleviates the scenario where an individual user authenticating through the authorization code grant type may not have adequate permissions to retrieve information for a changed resource.
42-
See [Developer Managed Service Accounts](/documentation/developer-managed-service-accounts) for additional information.
50+
See [Developer Managed Service Accounts](/documentation/building-data-connection-apps) for additional information.
51+
4352

4453
## Webhook Payload Definition
4554

0 commit comments

Comments
 (0)