Omniplex Docs

Tickets

These API endpoints are related to tickets on Omniplex

Get Ticket

GET
/tickets/{id}

Gets a support ticket. Requires you to be the author of the ticket or have the 'staff' permission

Authorization

User
headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

The ticket's ID

Response Body

Success

application/json
  1. response
author?
channel_id?string
close_user?
created_at?string
Formatdate-time
id?string
issue?string
mentions?
messages?array<>
open?boolean
ticket_context?
topic_id?string
Example Request
curl -X GET 'https://spider.omniplex.gg/tickets/string'
Example Response
{  "author": {    "avatar": "string",    "bot": true,    "display_name": "string",    "extra_data": {      "property1": null,      "property2": null    },    "flags": [      "string"    ],    "id": "string",    "status": "string",    "username": "string"  },  "channel_id": "string",  "close_user": {    "avatar": "string",    "bot": true,    "display_name": "string",    "extra_data": {      "property1": null,      "property2": null    },    "flags": [      "string"    ],    "id": "string",    "status": "string",    "username": "string"  },  "created_at": "2019-08-24T14:15:22Z",  "id": "string",  "issue": "string",  "mentions": {    "channels": {      "property1": "string",      "property2": "string"    },    "roles": {      "property1": {        "color": 0,        "name": "string"      },      "property2": {        "color": 0,        "name": "string"      }    },    "users": {      "property1": {        "avatar": "string",        "bot": true,        "display_name": "string",        "extra_data": {          "property1": null,          "property2": null        },        "flags": [          "string"        ],        "id": "string",        "status": "string",        "username": "string"      },      "property2": {        "avatar": "string",        "bot": true,        "display_name": "string",        "extra_data": {          "property1": null,          "property2": null        },        "flags": [          "string"        ],        "id": "string",        "status": "string",        "username": "string"      }    }  },  "messages": [    {      "attachments": [        {          "content_type": "string",          "errors": [            "string"          ],          "id": "string",          "name": "string",          "size": 0        }      ],      "author": {        "avatar": "string",        "bot": true,        "display_name": "string",        "extra_data": {          "property1": null,          "property2": null        },        "flags": [          "string"        ],        "id": "string",        "status": "string",        "username": "string"      },      "author_id": "string",      "content": "string",      "embeds": [        {          "author": {            "icon_url": "string",            "name": "string",            "proxy_icon_url": "string",            "url": "string"          },          "color": 0,          "description": "string",          "fields": [            {              "inline": true,              "name": "string",              "value": "string"            }          ],          "footer": {            "icon_url": "string",            "proxy_icon_url": "string",            "text": "string"          },          "image": {            "height": 0,            "proxy_url": "string",            "url": "string",            "width": 0          },          "provider": {            "name": "string",            "url": "string"          },          "thumbnail": {            "height": 0,            "proxy_url": "string",            "url": "string",            "width": 0          },          "timestamp": "2019-08-24T14:15:22Z",          "title": "string",          "type": "string",          "url": "string",          "video": {            "height": 0,            "proxy_url": "string",            "url": "string",            "width": 0          }        }      ],      "id": "string",      "timestamp": "2019-08-24T14:15:22Z"    }  ],  "open": true,  "ticket_context": {    "property1": "string",    "property2": "string"  },  "topic_id": "string"}

Patch Ticket

PATCH
/tickets/{id}

Closes or reopens a ticket. The author may close their own ticket; reopening requires staff. Returns 204 on success.

Authorization

User
headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

The ticket's ID.

Request Body

application/json
  1. body
open?boolean

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X PATCH 'https://spider.omniplex.gg/tickets/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}

Get Ticket Topics

GET
/tickets/topics

Returns the predefined list of topics a ticket can be filed under.

Response Body

Success

application/json
  1. response
topics?array<>
Example Request
curl -X GET 'https://spider.omniplex.gg/tickets/topics'
Example Response
{  "topics": [    {      "id": "string",      "name": "string"    }  ]}

Create Ticket Message

POST
/tickets/{id}/messages

Replies to a ticket. Requires being the ticket's author or staff with the 'manage_tickets' permission. Returns 204 on success.

Authorization

User
headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

The ticket's ID.

Request Body

application/json
  1. body
content?string

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X POST 'https://spider.omniplex.gg/tickets/string/messages' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}

Get Staff Tickets

GET
/staff/tickets

Gets every ticket platform-wide. Requires the 'view_tickets' staff permission. Called through the staff panel.

Query Parameters

open?string

Filter to open (true) or closed (false) tickets only. Omit for all tickets.

page?string

The page number, 1-indexed.

Response Body

Success

application/json
  1. response
tickets?array<>
Example Request
curl -X GET 'https://spider.omniplex.gg/staff/tickets'
Example Response
{  "tickets": [    {      "author": {        "avatar": "string",        "bot": true,        "display_name": "string",        "extra_data": {          "property1": null,          "property2": null        },        "flags": [          "string"        ],        "id": "string",        "status": "string",        "username": "string"      },      "channel_id": "string",      "close_user": {        "avatar": "string",        "bot": true,        "display_name": "string",        "extra_data": {          "property1": null,          "property2": null        },        "flags": [          "string"        ],        "id": "string",        "status": "string",        "username": "string"      },      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "issue": "string",      "mentions": {        "channels": {          "property1": "string",          "property2": "string"        },        "roles": {          "property1": {            "color": 0,            "name": "string"          },          "property2": {            "color": 0,            "name": "string"          }        },        "users": {          "property1": {            "avatar": "string",            "bot": true,            "display_name": "string",            "extra_data": {              "property1": null,              "property2": null            },            "flags": [              "string"            ],            "id": "string",            "status": "string",            "username": "string"          },          "property2": {            "avatar": "string",            "bot": true,            "display_name": "string",            "extra_data": {              "property1": null,              "property2": null            },            "flags": [              "string"            ],            "id": "string",            "status": "string",            "username": "string"          }        }      },      "messages": [        {          "attachments": [            {              "content_type": "string",              "errors": [                "string"              ],              "id": "string",              "name": "string",              "size": 0            }          ],          "author": {            "avatar": "string",            "bot": true,            "display_name": "string",            "extra_data": {              "property1": null,              "property2": null            },            "flags": [              "string"            ],            "id": "string",            "status": "string",            "username": "string"          },          "author_id": "string",          "content": "string",          "embeds": [            {              "author": {                "icon_url": "string",                "name": "string",                "proxy_icon_url": "string",                "url": "string"              },              "color": 0,              "description": "string",              "fields": [                {                  "inline": true,                  "name": "string",                  "value": "string"                }              ],              "footer": {                "icon_url": "string",                "proxy_icon_url": "string",                "text": "string"              },              "image": {                "height": 0,                "proxy_url": "string",                "url": "string",                "width": 0              },              "provider": {                "name": "string",                "url": "string"              },              "thumbnail": {                "height": 0,                "proxy_url": "string",                "url": "string",                "width": 0              },              "timestamp": "2019-08-24T14:15:22Z",              "title": "string",              "type": "string",              "url": "string",              "video": {                "height": 0,                "proxy_url": "string",                "url": "string",                "width": 0              }            }          ],          "id": "string",          "timestamp": "2019-08-24T14:15:22Z"        }      ],      "open": true,      "ticket_context": {        "property1": "string",        "property2": "string"      },      "topic_id": "string"    }  ]}

Staff: Get Ticket

GET
/staff/tickets/{id}

Gets any support ticket. Requires the 'view_tickets' staff permission. Called through the staff panel.

Path Parameters

id*string

The ticket's ID

Response Body

Success

application/json
  1. response
author?
channel_id?string
close_user?
created_at?string
Formatdate-time
id?string
issue?string
mentions?
messages?array<>
open?boolean
ticket_context?
topic_id?string
Example Request
curl -X GET 'https://spider.omniplex.gg/staff/tickets/string'
Example Response
{  "author": {    "avatar": "string",    "bot": true,    "display_name": "string",    "extra_data": {      "property1": null,      "property2": null    },    "flags": [      "string"    ],    "id": "string",    "status": "string",    "username": "string"  },  "channel_id": "string",  "close_user": {    "avatar": "string",    "bot": true,    "display_name": "string",    "extra_data": {      "property1": null,      "property2": null    },    "flags": [      "string"    ],    "id": "string",    "status": "string",    "username": "string"  },  "created_at": "2019-08-24T14:15:22Z",  "id": "string",  "issue": "string",  "mentions": {    "channels": {      "property1": "string",      "property2": "string"    },    "roles": {      "property1": {        "color": 0,        "name": "string"      },      "property2": {        "color": 0,        "name": "string"      }    },    "users": {      "property1": {        "avatar": "string",        "bot": true,        "display_name": "string",        "extra_data": {          "property1": null,          "property2": null        },        "flags": [          "string"        ],        "id": "string",        "status": "string",        "username": "string"      },      "property2": {        "avatar": "string",        "bot": true,        "display_name": "string",        "extra_data": {          "property1": null,          "property2": null        },        "flags": [          "string"        ],        "id": "string",        "status": "string",        "username": "string"      }    }  },  "messages": [    {      "attachments": [        {          "content_type": "string",          "errors": [            "string"          ],          "id": "string",          "name": "string",          "size": 0        }      ],      "author": {        "avatar": "string",        "bot": true,        "display_name": "string",        "extra_data": {          "property1": null,          "property2": null        },        "flags": [          "string"        ],        "id": "string",        "status": "string",        "username": "string"      },      "author_id": "string",      "content": "string",      "embeds": [        {          "author": {            "icon_url": "string",            "name": "string",            "proxy_icon_url": "string",            "url": "string"          },          "color": 0,          "description": "string",          "fields": [            {              "inline": true,              "name": "string",              "value": "string"            }          ],          "footer": {            "icon_url": "string",            "proxy_icon_url": "string",            "text": "string"          },          "image": {            "height": 0,            "proxy_url": "string",            "url": "string",            "width": 0          },          "provider": {            "name": "string",            "url": "string"          },          "thumbnail": {            "height": 0,            "proxy_url": "string",            "url": "string",            "width": 0          },          "timestamp": "2019-08-24T14:15:22Z",          "title": "string",          "type": "string",          "url": "string",          "video": {            "height": 0,            "proxy_url": "string",            "url": "string",            "width": 0          }        }      ],      "id": "string",      "timestamp": "2019-08-24T14:15:22Z"    }  ],  "open": true,  "ticket_context": {    "property1": "string",    "property2": "string"  },  "topic_id": "string"}
PATCH
/staff/tickets/{id}

Closes or reopens any support ticket. Requires the 'manage_tickets' staff permission. Called through the staff panel.

Path Parameters

id*string

The ticket's ID.

Request Body

application/json
  1. body
open?boolean

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X PATCH 'https://spider.omniplex.gg/staff/tickets/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}

Staff: Reply to Ticket

POST
/staff/tickets/{id}/messages

Replies to any support ticket as the signed-in staff member. Requires the 'manage_tickets' staff permission. Called through the staff panel.

Path Parameters

id*string

The ticket's ID.

Request Body

application/json
  1. body
content?string

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X POST 'https://spider.omniplex.gg/staff/tickets/string/messages' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}

Get User Tickets

GET
/users/{user_id}/tickets

Gets every ticket the given user has opened.

Authorization

User
headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

user_id*string

The ID of the user.

Response Body

Success

application/json
  1. response
tickets?array<>
Example Request
curl -X GET 'https://spider.omniplex.gg/users/string/tickets'
Example Response
{  "tickets": [    {      "author": {        "avatar": "string",        "bot": true,        "display_name": "string",        "extra_data": {          "property1": null,          "property2": null        },        "flags": [          "string"        ],        "id": "string",        "status": "string",        "username": "string"      },      "channel_id": "string",      "close_user": {        "avatar": "string",        "bot": true,        "display_name": "string",        "extra_data": {          "property1": null,          "property2": null        },        "flags": [          "string"        ],        "id": "string",        "status": "string",        "username": "string"      },      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "issue": "string",      "mentions": {        "channels": {          "property1": "string",          "property2": "string"        },        "roles": {          "property1": {            "color": 0,            "name": "string"          },          "property2": {            "color": 0,            "name": "string"          }        },        "users": {          "property1": {            "avatar": "string",            "bot": true,            "display_name": "string",            "extra_data": {              "property1": null,              "property2": null            },            "flags": [              "string"            ],            "id": "string",            "status": "string",            "username": "string"          },          "property2": {            "avatar": "string",            "bot": true,            "display_name": "string",            "extra_data": {              "property1": null,              "property2": null            },            "flags": [              "string"            ],            "id": "string",            "status": "string",            "username": "string"          }        }      },      "messages": [        {          "attachments": [            {              "content_type": "string",              "errors": [                "string"              ],              "id": "string",              "name": "string",              "size": 0            }          ],          "author": {            "avatar": "string",            "bot": true,            "display_name": "string",            "extra_data": {              "property1": null,              "property2": null            },            "flags": [              "string"            ],            "id": "string",            "status": "string",            "username": "string"          },          "author_id": "string",          "content": "string",          "embeds": [            {              "author": {                "icon_url": "string",                "name": "string",                "proxy_icon_url": "string",                "url": "string"              },              "color": 0,              "description": "string",              "fields": [                {                  "inline": true,                  "name": "string",                  "value": "string"                }              ],              "footer": {                "icon_url": "string",                "proxy_icon_url": "string",                "text": "string"              },              "image": {                "height": 0,                "proxy_url": "string",                "url": "string",                "width": 0              },              "provider": {                "name": "string",                "url": "string"              },              "thumbnail": {                "height": 0,                "proxy_url": "string",                "url": "string",                "width": 0              },              "timestamp": "2019-08-24T14:15:22Z",              "title": "string",              "type": "string",              "url": "string",              "video": {                "height": 0,                "proxy_url": "string",                "url": "string",                "width": 0              }            }          ],          "id": "string",          "timestamp": "2019-08-24T14:15:22Z"        }      ],      "open": true,      "ticket_context": {        "property1": "string",        "property2": "string"      },      "topic_id": "string"    }  ]}

Create Ticket

POST
/users/{user_id}/tickets

Opens a new standalone support ticket. Returns the new ticket's ID.

Authorization

User
headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

user_id*string

The ID of the user opening the ticket.

Request Body

application/json
  1. body
issue?string
message?string
topic?string

Response Body

Success

application/json
  1. response
id?string
Example Request
curl -X POST 'https://spider.omniplex.gg/users/string/tickets' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string"}