The Retrieve Webhook Event endpoint provides detailed information
about a specific webhook event. By using the event ID as a
parameter, merchants can access all the attributes and data
related to that particular event. This includes the event name,
response details, and timestamps, offering a complete view of the
event's lifecycle.
Accessing the details of a specific webhook event is essential
for troubleshooting and auditing purposes. If an event fails or
behaves unexpectedly, merchants can investigate the exact
circumstances surrounding the event. The detailed information
retrieved through this endpoint helps identify issues such as
network errors, incorrect endpoint configurations, or response
timeouts.
Authorization header with access token is required to access this endpoint: Bearer ACCESS-TOKEN
Your access token should be associated to this permission developer.webhook_events.view
Request
Request body schema:
application/json
Path parameters:
webhook_event_id
required
webhook_event_id
required
Type: ulid
Length: 26
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.
A list of additional webhook event related objects to eager-load
and return with the response. Pass only the relations you need to
keep response payloads lean.
See Including Resources
for the full list of supported include values and usage details.
Response
200
Response schema:
application/json
Response body:
webhook_event
webhook_event
Type: object
The webhook event record including event type, payload,
delivery status, and timestamps.
id
id
Type: ulid
Length: 26
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.
url
url
Type: url
Max: 1000
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.payment_link.created,
payment.checkout.created). It categorizes the events
for better organization and processing, enabling merchants to
understand and handle different types of events appropriately.
version
version
Type: enum
Possible values:
JSON
["v1"]
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.
signature_secret
signature_secret
Type: string
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.
details
details
Type: mixed
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.payment_link.created, payment.checkout.created). This
attribute provides the essential information needed to process and respond
to the event appropriately.
attempts_count
attempts_count
Type: integer
This attribute shows the number of attempts associated with the webhook
event.
failed_attempts_count
failed_attempts_count
Type: integer
This attribute shows the number of failed attempts associated with the
webhook event.
success_attempts_count
success_attempts_count
Type: integer
This attribute shows the number of success attempts associated with the
webhook event.
latest_attempt
latest_attempt
Type: object|null
The webhook event latest attempt model details.
id
id
Type: ulid
Length: 26
The unique ID assigned to each webhook event attempt 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 attempt. This ULID is
automatically created by our system and is used to uniquely identify
and track each webhook event attempt in our database.
request_body
request_body
Type: object
This attribute contains the original payload sent with the webhook
event. It holds all the data included in the webhook notification,
providing all the details necessary to understand and process the
event. The structure of this attribute varies based on the
webhook eventtype attribute, ensuring that all relevant information specific to the event type is included.
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 nature of the webhook event. It
helps to identify the kind of event that triggered the webhook
notification (e.g., payment.payment_link.created,
payment.checkout.created). It categorizes the events
for better organization and processing, enabling merchants to
understand and handle different types of events appropriately.
version
version
Type: enum
Possible values:
JSON
["v1"]
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.
fired_at
fired_at
Type: datetime
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.
webhook_event_attempt
webhook_event_attempt
Type: object
The webhook event attempt model basic details.
id
id
Type: ulid
Length: 26
The unique ID assigned to each webhook event attempt 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 attempt. This ULID is
automatically created by our system and is used to uniquely identify
and track each webhook event attempt in our database.
sent_at
sent_at
Type: datetime
This attribute records the exact timestamp when the webhook
notification was sent. This timestamp helps in tracking the timing
of the notification and correlating it with other events or logs.
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.
details
details
Type: mixed
This attribute holds the various details and information relevant to
the event type. It encapsulates all the data required to understand
and process the event, ensuring that the webhook endpoint receives
comprehensive information.
request_headers
request_headers
Type: object
This attribute contains the HTTP headers sent with the webhook
event attempt request. It ensures that the receiving server has
all the necessary information to correctly parse and validate
the incoming webhook event.
Content-Type
Content-Type
Type: string
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.
X-Payiano-Webhook-Event-Id
X-Payiano-Webhook-Event-Id
Type: string
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.
X-Payiano-Webhook-Event-Attempt-Id
X-Payiano-Webhook-Event-Attempt-Id
Type: string
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.
X-Payiano-Webhook-Signature
X-Payiano-Webhook-Signature
Type: string
This header contains the HMAC signature of
the webhook event. The signature is generated using a signature secret
shared between Payiano and the merchant. It is used
to verify the integrity and
authenticity of the webhook event. The receiving server can use this signature
to ensure that the payload has not been tampered with and that it indeed comes
from Payiano.
response_time
response_time
Type: integer
This attribute indicates the duration, in milliseconds, that
the webhook endpoint took to respond to the notification request.
This metric helps in evaluating the performance and responsiveness
of the webhook URL.
response_code
response_code
Type: integer
This attribute attribute records the HTTP status code returned by the
webhook endpoint. It provides insight into the success or failure of
the notification delivery (e.g., 200 for success, 404 for not
found, 500 for server error).
response_body
response_body
Type: mixed|null
This attribute contains the actual content returned by the webhook
endpoint. This can include any data or message provided by the server,
which can be useful for debugging and validation purposes. To manage
storage efficiently and maintain performance, the response body is
truncated to a maximum of 5000 characters. This ensures that
excessively large responses do not impact the system's performance
or storage capacity.
response_headers
response_headers
Type: mixed|null
This attribute contains the HTTP headers returned by the webhook
endpoint. These headers can provide additional context about the
response, such as content type, server details, and caching information.
is_error
is_error
Type: boolean
This attribute indicates whether the webhook notification failed
to be delivered or processed correctly. It will be true if
the response code is 400 or higher, indicating an
error, and false otherwise.
is_success
is_success
Type: boolean
This attribute indicates whether the webhook notification was
successfully delivered and processed. It will be true if
the response code is in the range of 2xx indicating
success, and false otherwise.
webhook_event_id
webhook_event_id
Type: ulid
This attribute serves as a foreign key linking the attempt to the
corresponding webhook event
model. This association ensures referential integrity and allows
for precise tracking and correlation of the notification with its
originating event.
sent_at
sent_at
Type: datetime
This attribute records the exact timestamp when the webhook
notification was sent. This timestamp helps in tracking the timing
of the notification and correlating it with other events or logs.
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.
created_at
created_at
Type: datetime
The created datetime of the webhook event attempt.
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.
updated_at
updated_at
Type: datetime
The updated datetime of the webhook event attempt.
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.
fired_at
fired_at
Type: datetime
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.
is_deleted
is_deleted
Type: boolean
Default: false
Indicates whether the webhook event has been soft-deleted. A true
value means the record is marked as deleted and excluded from standard
listings; a false value means it is active. Soft-deleted records
remain in the database and can be restored.
created_at
created_at
Type: datetime
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.
updated_at
updated_at
Type: datetime
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.
deleted_at
deleted_at
Type: datetime|null
The deleted 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.