Webhook Messages
Each incoming webhook received by FlexDeploy will be saved as a Webhook Message. This provides a way to track everything that's coming in and debug as needed. Messages can be viewed from the menu at Administration → Incoming Webhooks.
Viewing Messages
The table shows all webhooks received within the last week. Messages are purged automatically after 7 days.
Field | Description |
|---|---|
Status | The status of the message. Can be SUCCESS, PENDING, or FAILED |
Function Name | The function the message’s Uri was matched to |
Provider Name | The provider the message was matched to |
Uri | The uri where the webhook was received |
Message | A message containing more detail on the execution. This message can be set in a function script by using the LOG.setMessage function. If any errors occur during execution, the message will be overwritten |
Submitted On | Date and time the webhook message was submitted on |
Resubmitted By | User who resubmitted the webhook internally. Will be blank if webhook was not resubmitted |
Message Id | The id given to message |
Actions | Context menu of available actions for each message (Resubmit, View Details, Copy Id, View Provider, View Function) |
Viewing Message Details
Click on any webhook message row in the table to view more details in a popup about an individual function execution of a message. This will show more detail about the execution and the context about the incoming webhook.
There are three tabs in the popup. The first is Logs which will show any log messages printed in provider match script and the associated function script using the LOG methods. The Details tab will show Query Parameters, Headers, and any Additional Properties associated with the message. The final tab, Payload, will show the entire payload received from the message. There are Global Permission that can be defined on groups to control who is allowed to view specific tabs in this popup.
You can also resubmit the Incoming Webhook Message to be executed again by clicking the Resubmit Message button in the bottom right of the popup. There is a Global Permission defined on groups to control who is allowed to resubmit Webhook Messages.
Warning
Often times certain headers will be used to validate incoming messages, as such you should ensure that only select individuals have access to view the message details and payload. Leaving this information open for everyone in your organization to see could result in security issues. You can control access to this via the 'View Message Details' Global Permission.
Log Messages
Logs are printed by using the LOG methods in the provider match and function scripts. By default, the logging level will be based on the global FlexDeploy logging level. This can be modified specifically for webhook logs by setting the logging level for flexagon.fd.services.groovy.functions.LogFunctions in Administration → Admin Operations.
Some internal logs are printed automatically during execution. These logs will be at FINEST level.
Notice
For non-admin users Headers that contain a key of "authorization", "bearer", and "token" will display "*****" as the value for security reasons.
- style