documentation logo
All you’ll ever need to know about Declarative Webhooks and how to get started.

Pages

Step 4: Callout Template Response Body

Define the expected response

The Response Body section works the same as the JSON Request Body, however, you don’t need to map any fields at this step. Simply select Node and Node Type.

The Node and Node Type describes what the response from the server will look like.  

Create from sample JSON request

If you utilized the ‘Create from sample JSON request’ button in the previous step, your API documentation from the app or platform being implemented will also have a Returns section that you can copy from. In the previous example, we used QuickBooks, so we’ll reference this in the example below:

image66

 

Just as we did previously, copy the Returns sample from API documentation and select ‘Generate from sample JSON’ button and paste your example.

You will see the Return Body generated for you. As mentioned, you can also do this manually by creating your Node Name and Node Type, but again, no values or fields will be mapped.

 

Generate based on fields from Main Object

If you want to generate the JSON body based on fields from the main object, click the “Generate from Main Object fields” button.

It will open a popup that will allow you to select the fields used to generate the body.

Once you select all the fields, click “Generate and replace existing body” and see the JSON body being generated for you.