v12.11.0

V2 Staging API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

REST API v2. Authenticate with a Bearer JWT in the Authorization header unless an endpoint is marked public.

Servers

https://v2-staging.tscheckout.comCurrent host

---

Webhooks

Endpoints to interact with webhooks

Operations

GET/api/v2/webhooksPOST/api/v2/webhooksGET/api/v2/webhooks/{id}DELETE/api/v2/webhooks/{id}PATCH/api/v2/webhooks/{id}POST/api/v2/webhooks/bulk-deleteGET/api/v2/webhook/{id}DELETE/api/v2/webhook/{id}PATCH/api/v2/webhook/{id}GET/api/v2/webhookPOST/api/v2/webhookGET/api/v2/webhook/run

---

List webhooks

GET

/api/v2/webhooks

Returns a list of webhooks

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Webhook list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/webhooks

Playground

Authorization

bearerAuth

Samples

---

Create webhook

POST

/api/v2/webhooks

Create a new webhook

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Created webhook

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/webhooks

Playground

Authorization

bearerAuth

Body

Samples

---

Get webhook by ID

GET

/api/v2/webhooks/{id}

Returns a single webhook by ID

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Webhook ID

Type

integer

Required

Format

"int64"

Responses

Webhook object

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/webhooks/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete webhook

DELETE

/api/v2/webhooks/{id}

Delete a webhook

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Webhook ID

Type

integer

Required

Format

"int64"

Responses

Webhook deleted successfully

DELETE

/api/v2/webhooks/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update webhook

PATCH

/api/v2/webhooks/{id}

Update an existing webhook

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Webhook ID

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Updated webhook

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/webhooks/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Delete multiple webhooks

POST

/api/v2/webhooks/bulk-delete

Deletes multiple webhooks

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

[

  

  

  

1,

  

  

  

2,

  

  

  

3

  

  

]

  

]

}

Responses

Webhooks deleted successfully

POST

/api/v2/webhooks/bulk-delete

Playground

Authorization

bearerAuth

Body

Samples

---

Find Webhook by Id

GET

/api/v2/webhook/{id}

Returns a single Webhook

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

id

Type

integer

Required

Format

"int64"

Responses

GET

/api/v2/webhook/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete one Webhook by Id

DELETE

/api/v2/webhook/{id}

Deletes the identified Webhook

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

id

Type

integer

Required

Format

"int64"

Responses

DELETE

/api/v2/webhook/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update Webhook by Id

PATCH

/api/v2/webhook/{id}

Updates an existing Webhook from the PATCH data

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

id

Type

integer

Required

Format

"int64"

Request Body

application/json

{

  

"data": "string"

}

Responses

PATCH

/api/v2/webhook/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Find a list of Webhooks by a set of filters

GET

/api/v2/webhook

Returns a list of Webhooks

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

_limit

Set the max number of objects to return

Type

number

Format

"int64"

_offset

Set the number of objects to ignore before starting

Type

number

Format

"int64"

_search

text string that will search certain text fields

Type

string

_select

comma separated list of items to select ('tickets.*, ticketTypes.name')

Type

string

type

type

Type

string

display

display

Type

string

objectType

objectType

Type

string

Responses

GET

/api/v2/webhook

Playground

Authorization

bearerAuth

Variables

Key

Value

_limit

_offset

_search

_select

type

display

objectType

Samples

---

Create Webhook

POST

/api/v2/webhook

Creates a new Webhook from the POST data

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

POST

/api/v2/webhook

Playground

Authorization

bearerAuth

Body

Samples

---

Run a Webhook of a specific type

GET

/api/v2/webhook/run

Runs the enabled webhooks of a specific type on the referenceId

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

type*

Webhook type (should be one of these): orderComplete, attendeeCheckinComplete, ticketClaimComplete, ticketCancelComplete, orderCancelComplete, informationChangeComplete, orderRefundComplete, orderInformationChangeComplete

Type

string

Required

referenceId

should be the order Id for all types except attendeeCheckinComplete, ticketClaimComplete and ticketCancelComplete in which case it should be the ticketId

Type

string

Responses

GET

/api/v2/webhook/run

Playground

Authorization

bearerAuth

Variables

Key

Value

type*

referenceId

Samples

---

Powered by VitePress OpenAPI