Skip to main content

AssignmentPro API - How to create a Webhook System Profile

The API Subscription Manager screen allows for the configuration of System Profiles for Webhooks so that the parameters required by target systems to authenticate messages can be input on the screen.

Updated over 2 weeks ago

The API Subscription Manager screen allows for the configuration of System Profiles for Webhooks so that the parameters required by target systems to authenticate messages can be input on the screen. Once a System Profile is created, the profile set up for the receiving system can be selected when creating a Webhook on the Quick Workflow screen.

To create a Webhook profile, navigate to the Webhook Profiles tab on the API Subscription Manager screen and click the + icon.

On the Webhook Profiles tab, populate the Name, Content Type, HTTP Verb and Secret Key fields. with assistance from a Client technical resource that is familiar with the requirements of the target system that Webhooks will be sent to.

In addition, users can define Claims that are used to build the JWT or authentication token that may be required by target systems which will receive Webhooks. Press the

to add a new row in the Claims section and populate the Key and Value fields. Press

to save all changes.

Did this answer your question?