A Webhook Template (WHT) is an excellent tool for Agencies that want to provide easy-to-use Webhooks to the Companies under their purview. The WHT that the Agency creates will be available for the Companies to use in the Webhook Builder.
When creating a WHT, please refer to the documentation on how to create a webhook from scratch for Agencies, as it works much in the same way as Webhook creation, with a few key differences:
- Only Agencies can create WHTs.
- When using the WHT, values may be inserted later by the Company. The WHT creator decides which values are optional or required to use the WHT. For example, you can decide whether Headers and Params are required in the Webhook instance.
- In Basic Data, you are able to insert an image file which you will display in the Webhook Builder.
It is important to remember that any values that the Agency puts into the WHT will be hardcoded, and will, therefore, be unable to be altered by the Company.
In Basic Data, it may be useful to Companies for the Agency that creates the WHT to add a description. It should include the following items:
- What the Webhook should be used for.
- Authentication type information and how the Company can locate the relevant authentication details needed to use the Webhook.
- Any requirements that the Company might have to fulfill, such as a required subscription type to a third-party platform in order to be able to use that WHT.
- Description of any other fields to be added when using the WHT. Examples could be query params and/or other fields to be sent in the request body.
- Which Custom Variables are created by the Webhook.
- A link to any relevant documentation on the API used in the Webhook.
When you're finished with your WHT, you can either make it available for the Companies you manage, or you can save it as private if you're not quite ready to release it.