Webhook

Retrieves the collection of Webhook resources.

Retrieves the collection of Webhook resources.

SecurityBearer
Request
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses
200

Webhook collection

get/webhooks
Request samples 
Response samples 
[
  • {
    }
]
Creates a Webhook resource.
Creates a Webhook resource.


SecurityBearer 
Request 
Request Body schema: 
required
The new Webhook resource


event
required
string
 Enum: "connect" "reconnect" "payment"  
targetUrl
required
authenticationType
string or null
 Enum: "query" "header"  
authenticationKey
string or null
 
authenticationToken
string or null
 
Responses 
201
Webhook resource created


400
Invalid input


422
Unprocessable entity


post/webhooks
Request samples 
{
  • "event": "connect",
  • "targetUrl": "http://example.com",
  • "authenticationType": "query",
  • "authenticationKey": "string",
  • "authenticationToken": "string"
}
Response samples 
{
  • "uuid": "string",
  • "event": "connect",
  • "targetUrl": "string",
  • "authenticationType": "string",
  • "authenticationKey": "string",
  • "authenticationToken": "string"
}
Retrieves a Webhook resource.
Retrieves a Webhook resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string <uuid> 
 
Responses 
200
Webhook resource


404
Resource not found


get/webhooks/{uuid}
Request samples 
Response samples 
{
  • "uuid": "string",
  • "event": "connect",
  • "targetUrl": "string",
  • "authenticationType": "string",
  • "authenticationKey": "string",
  • "authenticationToken": "string"
}
Replaces the Webhook resource.
Replaces the Webhook resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string <uuid> 
 
Request Body schema: 
required
The updated Webhook resource


event
required
string
 Enum: "connect" "reconnect" "payment"  
targetUrl
required
authenticationType
string or null
 Enum: "query" "header"  
authenticationKey
string or null
 
authenticationToken
string or null
 
Responses 
200
Webhook resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/webhooks/{uuid}
Request samples 
{
  • "event": "connect",
  • "targetUrl": "http://example.com",
  • "authenticationType": "query",
  • "authenticationKey": "string",
  • "authenticationToken": "string"
}
Response samples 
{
  • "uuid": "string",
  • "event": "connect",
  • "targetUrl": "string",
  • "authenticationType": "string",
  • "authenticationKey": "string",
  • "authenticationToken": "string"
}
Removes the Webhook resource.
Removes the Webhook resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string <uuid> 
 
Responses 
204
Webhook resource deleted


404
Resource not found


delete/webhooks/{uuid}
Request samples