Subscribe to Ticket events

Subscribe to Ticket Events

Endpoint:POST https://hq.staging.netevia.dev/api/v1/tickets/subscribe

**Description:**Subscribes a client to receive real-time updates for ticket-related events via a callback URL. Once subscribed, the system will notify the provided URL whenever the following events occur:

  • Status changes – Ticket status updates (e.g., Open → Resolved).
  • New attachments – A file or media is added to a ticket.
  • New comments – A comment is posted to a ticket thread.

Request Body Parameters

ParameterTypeRequiredDescription
callbackUrlstringYesThe URL to which event notifications will be sent.

Example Request Body:

{
  "callbackUrl": "https://yourdomain.com/webhook/tickets"
}

Response

Returns a success status indicating whether the subscription was successfully created.

Response Example:

{
  "data": true,
  "requestId": 0,
  "success": true,
  "error": "string",
  "validationErrors": [
    {
      "field": "string",
      "error": "string"
    }
  ]
}

Response Fields

FieldTypeDescription
databooleanIndicates if the subscription request was successful.
requestIdnumberInternal request tracking ID.
successbooleanOverall success status of the API call.
errorstringError message if the request failed.
validationErrorsarrayList of validation issues, each containing a field and error.
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!