For general information on testing in the Workflow Builder, refer to this article: Testing Workflows
Testing your workflows in the builder is essential to speeding up your process in the Workflow Builder. This article covers how to test both Proposify triggers and actions in your workflows.
Included in the Trigger section, you'll find a list of all the triggers and sample data you can use when building workflows.
Authentication
You don't need to worry about setting up Proposify's authentication when starting a new workflow from one of the available workflow templates, but you will need to do a couple of steps when starting from scratch.
To start, go to the Configuration wizard in the workflow builder:
You can update the connection name, but make sure the connection name contains "Proposify Connect" for the API credentials to auto insert for the next step.
Now scroll down until you see Client ID and Client Secret.
Click on the gear icon next to each and click on the dropdown to change the permission to “Embedded”. This allows Proposify to autopopulate the Client ID and Secret when Proposify is connected.
After updating the fields, make sure to scroll to the bottom and hit Save.
You may need to enter in some random text in the Client Secret and ID as a placeholder. This will be replaced with the proper values when the workflow or automation is connected.
To finish testing the authentication, click on Test Configuration at the bottom of the page, and then on Test-instance configuration.
Finally, click Connect on the block for Proposify.
Testing
With Proposify's API authenticated, it's time to test. There are two types of blocks for Proposify. Trigger and actions. The Proposify trigger will fire based on any events selected. For actions, you can view the full list here in the API docs: https://apidocs.proposify.com/
Testing triggers
There's only one trigger for Proposify, but there are several options within the trigger for events that can be used to trigger. The events and sample data are listed at the end of this section.
To set up testing data for a trigger, start by clicking on Test Configuration and then click on Trigger payload.
Copy one of the example payloads below into the code box and hit Save. Make sure to replace the IDs you need with IDs from your account. You can find steps on finding these IDs in this section: Proposify object IDs
Trigger sample data
-
{
"id": "722f78e9-ae13-49d9-b773-36da66c12a97",
"type": "documentv2.created",
"time": "2024-10-04T12:58:33.768627Z",
"document_id": 1234,
"name": "Test document name",
"user_id": 1234,
"client_id": 1234
} -
{
"id": "28f232ef-1eaa-4e94-bfb6-3cdd3a807fd3",
"type": "documentv2.approved",
"time": "2024-10-04T13:02:07.992231Z",
"document_id": 1234,
"name": "Test document name",
"user_id": 1234,
"client_id": 1234,
"approved_datetime": "2024-10-04 10:02:07",
"approved_user_id": 1234
} -
{
"id": "640eb62f-8339-444b-bf35-62f47e6007a7",
"type": "documentv2.viewed",
"time": "2024-10-04T13:03:16.72522Z",
"document_id": 1234
} -
{
} -
{
"id": "4bf3bef5-4277-4d40-acf7-83def8970ef6",
"type": "documentv2.won",
"time": "2024-09-20T12:39:40.847118Z",
"document_id": 7069493,
"name": "Test document name",
"user_id": 1234,
"client_id": 1234
} -
{
"id": "b9597192-8c7b-4e17-905e-d7098f349d4b",
"type": "documentv2.lost",
"time": "2024-10-08T00:17:27.948746Z",
"document_id": 1234,
"name": "Test document name",
"user_id": 1234,
"client_id": 1234
}
Once you have the test data in place, the next time you click Run to test the workflow, it'll use the test data you provided. Make sure to run the workflow once to make data available for referencing in later actions.
Testing actions
For completed integrations, you'll want to use references to the output of the trigger or previous steps, but when testing you can also hard-code in values. List of Proposify object IDs
For example, with the action for Document Get V2, you can find and use a Document ID from your account to test the workflow and see the output.
Proposify object IDs
When testing in the Workflow Builder, it can be useful to directly use an ID in the test. Here's a list of IDs and where to get them in Proposify:
- The document ID can be found from the document snapshot page or from the editor. It's the number at the end of the URL.
- The Client ID/Company ID can be found by searching for a client and clicking to edit them, or clicking to edit the company instead.
Once again, the ID can be found at the end of the URL - User ID can be found from the view/edit user page. Go to user, click on a profile, and you can see the user ID at the end of the URL.