Webhooks Subscriptions

The Webhooks Subscription Advanced tool (formerly called API Credentials) allows users with access to view and manage webhook subscription endpoints.

Permission Required

To view this page, you must have access to the Webhook Subscriptions tool, given in the Advanced Access tab.

To navigate to this tool, click Main Menu > Advanced and select Webhook Subscriptions from the left side menu. If applicable, select the desired Org from the dropdown at the top of the page.

To read more about the details of the API and how to receive and verify webhooks, read Filevine's API Documentation:

• For US users
• For Canadian users

Subscriptions

All existing subscriptions are listed, including the following information: 

• Name
• Signature 
• Endpoint URL
• Events
• Last Modified

Create New Subscription

Click Create New Subscription at the top to open the new subscription flyout. In the flyout, select the Webhook Signature, enter the name and description, and enter the endpoint URL.

Enter the name, description, and endpoint URL. Select the desired events by clicking the category dropdown and then toggling the desired event on. You can view a sample payload by selecting the information icon next to the event. 

When you have finished filling out the fields, click Create, and the webhooks will be added to the subscriptions list. 

Editing and Deleting Subscriptions

To view or edit a subscription, click on the information icon to the right of the subscription in the table. 

In the flyout, you can view the key, description, endpoint, and events. 

You can also delete the subscriptionin this flyout. Click the Delete Subscription in the bottom left corner of the flyout to delete the key. Use caution when deleting subscriptions. This action cannot be undone.