Queue - Webhook Tickets

Endpoint to create objects in the processing queue related to ticket webhooks.

📥 Postman Collection

Download Collection - Queue Integration

URLs

Method	URL	Action	Description
POST	/api/v1/integration/queue	Register	Creates an object in the processing queue for ticket webhook
GET	/api/v1/integration/queue/{id}	View	Checks the processing status of an object in the queue

Production:

{connect-producao}/api/v1/integration/queue

Staging:

{connect-homologacao}/api/v1/integration/queue

Authentication

All requests require an access token obtained from the Security endpoint. The token must be sent in the AccessToken header.

Create Object in Queue

Request

Endpoint: POST {connect-producao}/api/v1/integration/queue

Headers:

AccessToken: {access_token}
Content-Type: application/json

Body:

{
  "action": "ticket-create",
  "data": {
    "ticket_data": "value",
    "buyer_data": "value"
  }
}

Success Response

Status: 201 Created

{
  "id": "uuid-of-object",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Object created successfully",
  "processDate": null,
  "processStatus": "pending",
  "processMsg": null
}

Check Processing

Request

Endpoint: GET {connect-producao}/api/v1/integration/queue/{id}

Headers:

AccessToken: {access_token}

Success Response

Status: 200 OK

{
  "id": "uuid-of-object",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Processed successfully",
  "processDate": "2025-01-01T00:05:00Z",
  "processStatus": "completed",
  "processMsg": "Processing completed",
  "msg": {
    "action": "ticket-create",
    "data": {
      "ticket_data": "value",
      "buyer_data": "value"
    }
  }
}

Response Fields

Field	Type	Description
id	string	Unique identifier of the object in the queue
created	datetime	Object creation date
iCode	number	Internal status code
iMsg	string	Internal status message
processDate	datetime/null	Processing date (null if not yet processed)
processStatus	string	Processing status (pending, processing, completed, failed)
processMsg	string/null	Processing message
msg	object	Original request data

Implementation Example

async function createTicketWebhook(ticketData, accessToken) {
  const response = await fetch('{connect-producao}/api/v1/integration/queue', {
    method: 'POST',
    headers: {
      'AccessToken': accessToken,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      action: 'ticket-create',
      data: ticketData
    })
  });

  if (!response.ok) {
    throw new Error(`Error ${response.status}: ${response.statusText}`);
  }

  const result = await response.json();
  return result.id;
}

async function checkProcessing(queueId, accessToken) {
  const response = await fetch(`{connect-producao}/api/v1/integration/queue/${queueId}`, {
    method: 'GET',
    headers: {
      'AccessToken': accessToken
    }
  });

  if (!response.ok) {
    throw new Error(`Error ${response.status}: ${response.statusText}`);
  }

  return await response.json();
}