The Webhook Transformation Service is a feature in Agillic for modifying the default data format for a Webhook. You can use the service to ensure that recipient data is formatted to fit with what your external systems require.
You can export Person Data, One-to-Many Data, and data for a Global Data Tables in real-time through Agillic. The Webhook Transformation Service settings are under the 'Integrations' section in the Settings module.
In the Webhook Transformation Service section, you can find the following settings:
- Enable Webhook Transformation Service
- Webhook Transformation Scripts
- Webhook Transformation Script Details
- Webhook Transformation Script Content
Enable Webhook Transformation Service
When enabling the Webhook Transformation Service, you can set up and manage webhook transformation scripts to transform data coming from Agillic webhooks so it can be integrated directly with your external resources.
Webhook Transformation Scripts
Here, you can create new scripts and edit or delete existing ones. You can also access Webhook Transformation Scripts details, execution history, and script content.
Webhook Transformation Script Details
You can have a custom name and description for each webhook transformation script you created. You can set up the target URL for your external resource and add a custom header for authentication.
Webhook settings for enabling Webhook Transformation Service, creating new or edit/delete webhook transformation scripts, and adding webhook transformation script details
Webhook Transformation Script Content
Here, you can write your Webhook Transformation Script. You can write script code in the left pane, see a payload example from the webhook in the source panel in the top right, and see the outgoing HTTP calls in the result panel on the bottom right.
In the source panel, you select a webhook you previously created to see a payload example that will match the JSON schema when the webhook will be actually called. This payload example will be populated with mock data.
In the result panel, you can see a detailed list of HTTP calls that will be sent when the Webhook Transformation Script is getting executed. You can also run a test execution that will issue the HTTP calls with the mock data you can see in the source pane.
An example of webhook transformation script content