Skip to main content

Qala Publishing API (v1.0)

Download OpenAPI specification:Download

Events

Publish Events

Publishes Events to a Topic

Authorizations:
ApiKey
path Parameters
topicName
required
string
header Parameters
x-environment-id
required
string <guid>
Request Body schema: application/json
required
required
Array of objects (Event) non-empty
Array
type
required
string non-empty ^(?:[A-Za-z0-9.,_\-&()\[\]<>]{1,100})$
id
string
data
required
any

Responses

Request samples

Content type
application/json
{
  • "events": [
    • {
      • "type": "customer.created",
      • "id": "Example2",
      • "data": {
        • "customer_id": "123456",
        • "name": "John Doe",
        • "email": "johndoe@letsqala.com",
        • "createdAt": "2024-04-30T08:45:00",
        • "address": {
          • "street": "123 Main St",
          • "city": "Anytown",
          • "state": "CA",
          • "zipCode": "90210",
          • "country": "USA"
          }
        }
      }
    ]
}

Response samples

Content type
application/problem+json
{
  • "title": "One or more validation errors occurred.",
  • "status": 400,
  • "instance": "/api/route",
  • "traceId": "0HMPNHL0JHL76:00000001",
  • "detail": "string",
  • "errors": [
    • {
      • "name": "Error or field name",
      • "reason": "Error reason",
      • "code": "string",
      • "severity": "string"
      }
    ]
}

Security / Subscriber Groups

Create Subscriber Group Session Token

Creates a new Session Token for a Subscriber Group

Authorizations:
ApiKey
path Parameters
subscriberGroupId
required
string <guid>

Responses

Response samples

Content type
application/json
{
  • "sessionToken": "ABC-G-kbI6ZQ1nr4qbs-U81Nt_p93GpxeT_m43grreIEnVZjG53Sa5skfeN7YmSGGGSs-vIemIw7U_EXAMPLE-w"
}