Skip to content
Wink

Create Webhook

POST
/api/managing-entity/{managingEntityIdentifier}/webhook
 
curl --request POST \
  --url https://api.wink.travel/api/managing-entity//webhook \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "name": "", "entity": "", "enabled": true, "eventUrl": "", "eventList": [ "" ] }'

Create a new webhook

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Identifier of the managing entity that will own the webhook

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 webhook.

string
"" >= 1 characters
Example 
Webhook prod
entity
required

Name of the application.

object
identifier
required

Managing entity identifier.

string
"" >= 1 characters
Example 
123456789
name
required

Descriptive name of managing entity.

string
"" >= 1 characters
Example 
Managing entity prod
Example 
App 1
enabled
required

Whether this webhook is enabled.

boolean
default: true
Example 
true
eventUrl
required

The url to POST event to.

string
"" >= 1 characters
Example 
https://www.webhook.com/event
eventList
required
Array<string>

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

Media type application/json
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": [
    ""
  ]
}

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