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.
Change department – The ticket has been transferred to another department.

Request Body Parameters

Parameter	Type	Required	Description
`callbackUrl`	string	Yes	The 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

Field	Type	Description
`data`	boolean	Indicates if the subscription request was successful.
`requestId`	number	Internal request tracking ID.
`success`	boolean	Overall success status of the API call.
`error`	string	Error message if the request failed.
`validationErrors`	array	List of validation issues, each containing a `field` and `error`.

Success Response Example:

{
    "requestId": 12345,
    "success": true
}

Callback Example Body:

{
    "CallbackUrl": "https://example.com/callback",
    "TicketId": "12345",
    "EventType": "Add Comment",
    "MID": "9180000000000000",
    "Title": "Sample Ticket Title",
    "PreviousValue": "",
    "CurrentValue": "This is a sample comment added to the ticket."
}