Outgoing Webhook Messages
- Keith Ecker (Unlicensed)
- Pinnapureddy Dileep
- Joel Wenzel
Each event received by Webhook Listeners in FlexDeploy will be saved for a period of 7 days. This provides a way to track all the events that occur and debug as needed. Messages can be viewed by navigating to Administration → Integrations → Outgoing Webhooks and clicking the view messages button.
Viewing Messages
The table on the left side of the screen shows all events received within the last week. Messages are purged automatically after 7 days.
Field | Description |
|---|---|
Id *hidden | The id given to message |
Listener | The name of the listener that was executed |
Status | The status of the message. Can be SUCCESS, PENDING, or FAILED |
Event Type | The event type corresponding to the event. |
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 |
Created By *hidden | User who created the event |
Created On | Date and time of event message creation |
Object Name *hidden | Object for which the event occurred on. Typically a project or a release. |
Actor *hidden | Actor who caused the event, typically a user. |
Columns marked *hidden are not shown by default but can be added via the View option in the toolbar
Viewing Message Details
Click on any Webhook Message row in the table to view more details about an Listener execution.
Click the view payload button to view the entire payload received by the event listener. More information on the execution can be viewed by clicking the view logs button. This will show any log messages printed in the Listener scripts using the LOG methods. You can also re-submit a Listener execution with the Resubmit button. This is only meant to be used for debugging purposes. There is a global permission defined on groups to control who is allowed to resubmit event messages.
Log Messages
Logs are printed by using the LOG methods in the function scripts. By default, the logging level will be based on the global FlexDeploy logging level. This can be modified specifically for event logs by setting the logging level for flexagon.fd.services.groovy.functions.LogFunctions in Admin → Admin Operations.
Some internal logs are printed automatically during execution. These logs will be at FINEST level.
- style