Skip to content
Wink

Update

PATCH
/api/managing-entity/{managingEntityIdentifier}/webhook/{id}
 
curl --request PATCH \
  --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/webhook/b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "name": "", "entity": "", "enabled": true, "eventUrl": "", "eventList": [ "" ] }'

Applies the supplied changes to an existing webhook identified by its id and returns the updated record.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Identifier of the managing entity that owns the webhook

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

Unique webhook identifier

Example 
b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required

Descriptive name of this webhook, e.g. ‘Booking confirmation sync’ or ‘Payment notifications’.

string
"" >= 1 characters
Example 
Booking confirmation sync
entity
required

The managing entity (account owner) that will own this webhook.

object
identifier
required

Unique managing entity (account owner) identifier.

string format: uuid
"" >= 1 characters
Example 
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
name
required

Display name of the managing entity.

string
"" >= 1 characters
Example 
The Siam Residences, Bangkok
enabled
required

Whether this webhook is actively subscribed to events.

boolean
default: true
Example 
true
eventUrl
required

HTTPS endpoint URL to POST events to. Must be a valid, publicly accessible URL.

string
"" >= 1 characters
Example 
https://api.example.com/webhooks/wink/events
eventList
required
Array<string>

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
id
required

Document UUID

string format: uuid
"" >= 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 authenticated user identifier

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

Unique managing entity (owner) identifier

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

Display name of the managing entity that owns this webhook.

string
"" >= 1 characters
name
required

Descriptive name of this webhook, e.g. ‘Booking confirmation sync’ or ‘Payment notifications’.

string
"" >= 1 characters
enabled
required

Whether this webhook is actively subscribed to events.

boolean
default: true
eventUrl
required

HTTPS endpoint URL to POST events to. Must be a valid, publicly accessible URL.

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

400

Section titled “400 ”

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"
  }
}

401

Section titled “401 ”

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

403

Section titled “403 ”

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

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}