Webhook logs
Webhook logs are a type of log that record information about webhooks sent from FastAuth to your system.
Webhook logs can be useful for several purposes, including:
- Debugging: Webhook logs can help you troubleshoot issues with your webhook implementation by providing a detailed record of all webhook requests and responses.
- Monitoring: Webhook logs can help you monitor the performance and reliability of your webhook integration by tracking errors.
- Auditing: Webhook logs can help you maintain a record of all webhook activity, which may be useful for compliance and auditing purposes.
In FastAuth, webhook logs provide the ability to trigger a certain webhook with the data that was sent originally. This can be useful for testing and debugging webhook integrations, or for re-triggering failed or missed webhook requests.
List all logs for selected webhook:​
This endpoint returns a list of all logs for the specified webhook. To get a full list of log properties you need to use get log details
Get log details​
This endpoint returns a list of all log properties for the specified webhook.
Webhook Log Response DTO​
Fields of WebhookLogResponseDto class:
| Field | Type | Description |
|---|---|---|
Id | Guid | A unique identifier for the webhook log entry. |
EnrollmentId | Guid | The ID of the enrollment associated with the webhook. |
SentDate | DateTime | The date and time when the webhook was sent. |
Status | WebhookStatusType | The status of the webhook, as an enum of type WebhookStatusType. |
Topic | string | The topic of the webhook, indicating the event or data that triggered it. |
Url | string | The URL of the endpoint that the webhook was sent to. |
ErrorMessage | string | Any error message associated with the webhook, if applicable. |
WebhookData | JObject | A JSON object containing the data sent with the webhook. |
Response | string | The response received from the endpoint that the webhook was sent to. |
ResponseStatusCode | HttpStatusCode? | The HTTP status code received from the endpoint that the webhook was sent to. |
RelatedEntityId | Guid | The ID of a related entity. |
RelatedEntityType | string | The type of the related entity. |
Re-trigger the webhook​
The following endpoint can rerun the webhook.
All requests sent using this endpoint will have the same enrollmentId.
Data retention​
Webhook logs are stored for 90 days.