Retrieve Webhook Event Attempt

The webhook event model basic details.

The webhook event attempt model basic details.

This header specifies the media type of the resource. It indicates that the payload is in JSON format. It's essential for the receiving server to correctly parse the JSON payload of the webhook event.

This header contains a unique identifier for the webhook event. Each webhook request includes this header to help you track and correlate events in your system. The event ID is generated by Payiano and is unique to each webhook event, allowing for precise identification and troubleshooting. It can be used to verify the webhook signature using verify webhook signature endpoint.

This header contains a unique identifier for the specific attempt to deliver the webhook event. Since a webhook event can have multiple delivery attempts if the initial delivery fails, this ID helps to track each individual attempt. It can be used to verify the webhook signature using verify webhook signature endpoint.

The unique ID assigned to each webhook event which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every webhook event. This ULID is automatically created by our system and is used to uniquely identify and track each webhook event in our database.

This attribute specifies the endpoint where the webhook notifications will be sent. It points to the server or service that will handle the incoming webhook requests allowing the merchant to handle these events programmatically.

This attribute specifies the nature of the webhook event. It helps to identify the kind of event that triggered the webhook notification (e.g., payment_link.created, checkout.created). It categorizes the events for better organization and processing, enabling merchants to understand and handle different types of events ppropriately.

This attribute specifies the version of the webhook event. This helps in identifying and managing different versions of events, ensuring compatibility and consistency in the handling of webhook notifications. Versions like v1, v2, etc., indicate updates or changes in the event structure or payload, allowing merchants to adapt to the latest event formats.

This attribute holds the secret key used to generate the HMAC signature for the webhook event payload. This key is unique to each webhook URL and is used to ensure the integrity and authenticity of the webhook event. It should be kept private and secure and only known to the receiving server and authorized parties. This secret key is important for verifying that the payload has not been tampered with and that it indeed comes from Payiano. Please note this value is retrievable in the sandbox environment only, and it will be masked in the production environment.

This attribute contains the payload associated with the webhook event. The structure and content of this data vary based on the type attribute, reflecting the specific details relevant to the event type (e.g., payment_link.created, checkout.created). This attribute provides the essential information needed to process and respond to the event appropriately.

This attribute shows the number of attempts associated with the webhook event.

This attribute shows the number of failed attempts associated with the webhook event.

This attribute shows the number of success attempts associated with the webhook event.

This value indicates whether the webhook event is deleted or not. This flag can be used to control the webhook event's availability in runtime without actual deleting or removing the webhook event from records. A true value means the webhook event is deleted, while a false value implies that the webhook event is not deleted and functioning.

This attribute records the timestamp when the webhook event was triggered. It provides a precise log of when the webhook notification was sent, which is useful for tracking and debugging purposes. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

The created datetime of the webhook event. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

The updated datetime of the webhook event. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.