Skip to content

Show delivery

GET
/api/managing-entity/{managingEntityIdentifier}/webhook/delivery/{deliveryId}
curl --request GET \
--url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/webhook/delivery/b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47 \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

One delivery, including its full attempt history.

managingEntityIdentifier
required
string
""

Managing entity

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
deliveryId
required
string
""

Delivery identifier

Example
b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

The delivery

Media typeapplication/json

One delivery of an event to one webhook endpoint, with its attempt history.

object
attemptCount

Attempts made so far.

integer format: int32
""
attempts

Attempt history, oldest first.

Array<object>
""

One HTTP attempt of a delivery.

object
at

When the attempt was made.

string format: date-time
""
attempt

1-based attempt number.

integer format: int32
""
durationMs

Round-trip time in milliseconds.

integer format: int64
""
error

Transport error, if the request never completed.

string
""
httpStatus

HTTP status returned, null when the request never completed.

integer format: int32
""
responseSnippet

First 4 KB of the response body, if any.

string
""
createdDate

When the delivery was created.

string format: date-time
""
eventId

The event delivered.

string format: uuid
""
id

Delivery identifier (also sent as Wink-Delivery-Id).

string format: uuid
""
lastHttpStatus

HTTP status of the last attempt.

integer format: int32
""
lastUpdate

When the delivery last changed.

string format: date-time
""
nextAttemptAt

When the next attempt is due, if any.

string format: date-time
""
ownerIdentifier

Owning managing entity.

string format: uuid
""
status

Delivery status.

string
""
Allowed values: PENDING RETRYING SUCCEEDED DEAD CANCELLED
type

Event type key.

string
""
url

Endpoint URL at the time of delivery.

string format: uri
""
webhookId

The webhook subscription targeted.

string format: uuid
""
key
additional properties
""
Example
{
"type": "booking.create"
}

Bad Request — missing or invalid request parameter or body

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Unauthorized — authentication is required or the session has expired

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Forbidden — authenticated but lacking the required permission or scope

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Not Found — the requested resource does not exist

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Unsupported Media Type — use application/json

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Internal Server Error — an unexpected failure occurred on the server

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Service Unavailable — a downstream dependency is unreachable

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example