Webhook execution logs
Last updated
Was this helpful?
Last updated
Was this helpful?
Webhook execution logs make Email This Issue for Jira administrators able to monitor which webhooks have been called upon which incidents, and whether the associated HTTPs requests have been dispatched successfully.
To see Webhook execution logs, go to the Administration tab, and choose Webhook Execution Logs under WEBHOOKS.
If webhooks are called successfully the admins or all other addressed parties are informed about the source incidents through the preferred channel for which the webhook was configured.
If the webhook itself does not work properly, the incidents won't reach the receiving system, and won't be reported there either. To learn about such an issue, check the logs of webhook executions. Issues with webhook call dispatching cannot be reported in the style of push notifications, they must be actively checked (polled) periodically.
On the listing page of webhook execution logs items are ordered by their time of execution, in a descending order starting with the latest items. There are 100 items per page. Assuming that only the most recent logs may refer to relevant, current issues, execution logs can neither be filtered, nor deleted. They are automatically purged after 90 days.
Each log entry contains the most essential details about the incident that triggered the webhook call, and some additional information about the execution. especially in the event of failure in order to make troubleshooting possible. As some fields may contain lengthy text (for example, error messages extended with stacktrace), these parts are displayed as collapsed by default, but they can be expanded individually if needed.
The following attributes are revealed in a log entry:
Attribute
Description
Separate column in the log
Name
The entity that represents the execution of this webhook.
Yes
Event
The incident type (triggering event) for which the webhook was configured.
Yes
Entity name
The name of the entity (Incoming Connection, Outgoing Connection or Mail Handler) for which the incident occurred.
Yes
Error Message
The message value that was rendered in the request body. In most cases, this is the same message that can be found in the Error Queue of the failing component.
Yes
Time of Execution
The timestamp indicating when this execution entity was created (with Queued status).
Note: Webhooks are executed in an asynchronous manner, typically within a few moments after their creation. If it takes more time, the webhook execution remains in a Queued status until the actual dispatch.
Yes
Status
Has one of the following values:
Queued: Created, but not yet executed.
Successful: Executed successfully.
Failed: Executed, but failed.
Yes
Service URL called
The final URL that was actually called.
No
Webhook response
The HTTPs status code and message received from the remote endpoint (i.e. the response of the receiving service).
No
Request Headers Executed
The final generated Request Header that was sent with the request.
Note: Due to the peculiarities of the library used for dispatching the HTTPs request, the Content-Type header is not listed here, but it is always included included in the real request headers with the value of application/json.
No
Failure Reason
In the event of a failure (Failed status) this attribute shows the root cause, potentially an error message, and stacktrace.
Note: If the webhook execution resulted in a Success status (or is still Queued) this field is hidden.
No
