Qminder's backend sends HTTP requests to registered URLs every time a Ticket is created, called, served, re-called or changed.

Ticket created

This HTTP request is sent to the registered URL every time a Ticket was created in Qminder.

POST /webhooks HTTP/1.1
X-Qminder-Signature: SIGNATURE
Content-Type: application/json

{
  "type": "ticket_created",
  "data": {
    "id": "123456789",
    "status": "NEW",
    "source": "MANUAL",
    "line": 37338,
    "firstName": "Jane",
    "lastName": "Eyre",
    "phoneNumber": 12125551234,
    "created": {
      "date": "2020-05-15T00:15:24Z"
    },
    "extra": [
      {
        "title": "First time visitor?",
        "value": "Yes"
      }
    ]
  }
}

This HTTP request includes the following data fields in its request body:

Field name

Data type

Description

type

"ticket_created"

Always "ticket_created" for the Ticket Created event

data.id

string

The ID of the ticket that was created

...

Ticket

Other data fields come from the Ticket data model.
Read more about the Ticket data model.

Ticket called

This HTTP request is sent to the registered URL every time a Ticket was called in Qminder.

POST /webhooks HTTP/1.1
X-Qminder-Signature: SIGNATURE
Content-Type: application/json

{
  "type": "ticket_called",
  "data": {
    "id": "123456789",
    "status": "CALLED",
    "source": "MANUAL",
    "line": 37338,
    "firstName": "Jane",
    "lastName": "Eyre",
    "phoneNumber": 12125551234,
    "created": {
      "date": "2020-05-15T00:15:24Z"
    },
    "called": {
      "date": "2016-02-18T10:43:04Z",
      "caller": 14267,
      "desk": 3
    },
    "extra": [
      {
        "title": "First time visitor?",
        "value": "Yes"
      }
    ]
  }
}

This HTTP request includes the following data fields in its request body:

Field name

Data type

Description

type

"ticket_called"

Always "ticket_called" for the Ticket Called event

data.id

string

The ID of the ticket that was created

...

Ticket

Other data fields come from the Ticket data model.
Read more about the Ticket data model.

Ticket re-called

This HTTP request is sent to the registered URL every time a Ticket was called again in Qminder.

POST /webhooks HTTP/1.1
X-Qminder-Signature: SIGNATURE
Content-Type: application/json

{
  "type": "ticket_created",
  "data": {
    "id": "123456789",
    "status": "CALLED",
    "source": "MANUAL",
    "line": 37338,
    "firstName": "Jane",
    "lastName": "Eyre",
    "phoneNumber": 12125551234,
    "created": {
      "date": "2020-05-15T00:15:24Z"
    },
    "called": {
      "date": "2016-02-18T10:43:04Z",
      "caller": 14267,
      "desk": 3
    },
    "extra": [
      {
        "title": "First time visitor?",
        "value": "Yes"
      }
    ]
  }
}

This HTTP request includes the following data fields in its request body:

Field name

Data type

Description

type

"ticket_recalled"

Always "ticket_recalled" for the Ticket Re-called event

data.id

string

The ID of the ticket that was created

...

Ticket

Other data fields come from the Ticket data model.
Read more about the Ticket data model.

Ticket removed from queue

This HTTP request is sent to the registered URL every time a Ticket was removed from the queue in Qminder.

POST /webhooks HTTP/1.1
X-Qminder-Signature: SIGNATURE
Content-Type: application/json

{
  "type": "ticket_cancelled",
  "data": {
    "id": "123456789",
    "status": "CANCELLED_BY_CLERK",
    "source": "MANUAL",
    "line": 37338,
    "firstName": "Jane",
    "lastName": "Eyre",
    "phoneNumber": 12125551234,
    "created": {
      "date": "2020-05-15T00:15:24Z"
    },
    "extra": [
      {
        "title": "First time visitor?",
        "value": "Yes"
      }
    ]
  }
}

This HTTP request includes the following data fields in its request body:

Field name

Data type

Description

type

"ticket_cancelled"

Always "ticket_cancelled" for the Ticket Removed event

data.id

string

The ID of the ticket that was created

...

Ticket

Other data fields come from the Ticket data model.
Read more about the Ticket data model.

Ticket served

This HTTP request is sent to the registered URL every time a Ticket was served in Qminder.

POST /webhooks HTTP/1.1
X-Qminder-Signature: SIGNATURE
Content-Type: application/json

{
  "type": "ticket_served",
  "data": {
    "id": "123456789",
    "status": "SERVED",
    "source": "MANUAL",
    "line": 37338,
    "firstName": "Jane",
    "lastName": "Eyre",
    "phoneNumber": 12125551234,
    "created": {
      "date": "2020-05-15T00:15:24Z"
    },
    "called": {
      "date": "2016-02-18T10:43:04Z",
      "caller": 14267,
      "desk": 3
    },
    "served": {
      "date": "2016-02-18T10:53:19Z"
    },
    "extra": [
      {
        "title": "First time visitor?",
        "value": "Yes"
      }
    ]
  }
}

This HTTP request includes the following data fields in its request body:

Field name

Data type

Description

type

"ticket_served"

Always "ticket_served" for the Ticket Served event

data.id

string

The ID of the ticket that was created

...

Ticket

Other data fields come from the Ticket data model.
Read more about the Ticket data model.

Ticket changed

This HTTP request is sent to the registered URL every time a Ticket's information was changed in Qminder.

POST /webhooks HTTP/1.1
X-Qminder-Signature: SIGNATURE
Content-Type: application/json

{
  "type": "ticket_changed",
  "data": {
    "id": "123456789",
    "status": "NEW",
    "source": "MANUAL",
    "line": 37338,
    "firstName": "Jane",
    "lastName": "Eyre",
    "phoneNumber": 12125551234,
    "created": {
      "date": "2020-05-15T00:15:24Z"
    },
    "extra": [
      {
        "title": "First time visitor?",
        "value": "No"
      }
    ]
  }
}

This HTTP request includes the following data fields in its request body:

Field name

Data type

Description

type

"ticket_changed"

Always "ticket_changed" for the Ticket Changed event

data.id

string

The ID of the ticket that was created

...

Ticket

Other data fields come from the Ticket data model.
Read more about the Ticket data model.