Skip to content

Show Webhooks

GET
/api/managing-entity/{managingEntityIdentifier}/webhook/list
curl --request GET \
--url https://api.wink.travel/api/managing-entity//webhook/list \
--header 'Wink-Version: 2.0'

List all webhooks owned by the managing entity

managingEntityIdentifier
required
string
""

Identifier of the managing entity whose webhooks to list

Wink-Version
string
default: 2.0.0
Allowed values: 2.0

OK

Media type application/json
Array<object>
object
id
required

Document UUID

string
"" >= 1 characters
createdDate

Datetime this record was first created

string format: date-time
""
lastUpdate

Datetime this record was last updated

string format: date-time
""
version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64
""
userIdentifier
required

Unique owner record identifier

string format: uuid
"" >= 1 characters
ownerIdentifier
required

Unique owner record identifier

string format: uuid
"" >= 1 characters
ownerName
required

Name of company owner.

string
"" >= 1 characters
name
required

Descriptive name of webhook.

string
"" >= 1 characters
enabled
required

Whether this webhook is enabled.

boolean
default: true
eventUrl
required

The url to POST event to.

string
"" >= 1 characters
eventList
required
Array<string>
Example
[
{
"id": "",
"createdDate": "",
"lastUpdate": "",
"version": "",
"userIdentifier": "",
"ownerIdentifier": "",
"ownerName": "",
"name": "",
"enabled": true,
"eventUrl": "",
"eventList": [
""
]
}
]

Bad Request

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com",
"properties": {
"additionalProperty": "example"
}
}

Unauthorized

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

Internal Server Error

object
Example generated
{}