List webhook subscriptions

Returns your webhook subscriptions, newest first, 25 per page.

GET

https://app.touchsms.com.au/api/v2/webhook-subscriptions

Authorization

basicAuth
HTTP
required

Query parameters

page
optional
integer
Page number. Prefer following links.next until it is null.

minimum: 1 · default: 1

Returns

200

A page of webhook subscriptions.

JSON

data
optional
array of
object
- id
  optional
  integer
- status
  optional
  Active
  or
  Disabled
  or
  Disabled Failing
  Disabled Failing means the subscription was disabled automatically after repeated delivery failures and receives no events until re-enabled.
- event
  optional
  message_received
  or
  message_dlr
  or
  optout_created
  or
  message_received_3cx
  
  message_received: an inbound message was received.
  
  message_dlr: a delivery receipt was received for an outbound message.
  
  optout_created: a number opted out.
  
  message_received_3cx: an inbound message, formatted for 3CX.
- include_sent_status
  optional
  boolean
  Whether a message_dlr subscription also receives sent receipts. Always false for other events.
- name
  optional
  string
- url
  optional
  string
  format: uri
- request_method
  optional
  POST
  or
  GET
- request_encoding_type
  optional
  json
  or
  form
  or
  null
- headers
  optional
  array of
  object
  key
  string
  required
  A valid HTTP header name.
  
  maxLength: 50 · minLength: 3
  value
  string
  required
  maxLength: 200 · minLength: 3
- created_at
  optional
  string
  format: date-time
- updated_at
  optional
  string
  format: date-time
}
links
optional
object
Links to other pages. next is null on the last page.
- first
  optional
  string | null
  format: uri
- last
  optional
  string | null
  format: uri
- prev
  optional
  string | null
  format: uri
- next
  optional
  string | null
  format: uri
}
meta
optional
object
Position in the result set. Read per_page rather than assuming a page size.
- current_page
  optional
  integer
- from
  optional
  integer | null
- last_page
  optional
  integer
- path
  optional
  string
  format: uri
- per_page
  optional
  integer
- to
  optional
  integer | null
- total
  optional
  integer
- links
  optional
  array of
  object
  Page links for building pagination controls.
  
  url
  optional
  string | null
  label
  optional
  string
  active
  optional
  boolean
}

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

{ "data": [ { "id": 123, "status": "Active", "event": "message_received", "include_sent_status": false, "name": "Inbound to CRM", "url": "https://example.com/hooks/inbound", "request_method": "POST", "request_encoding_type": "json", "headers": [ { "key": "X-Api-Key", "value": "abc123" } ], "created_at": "2024-02-02T23:51:19Z", "updated_at": "2024-03-11T02:14:07Z" } ], "links": { "first": "https://app.touchsms.com.au/api/v2/contacts?page=1", "last": "https://app.touchsms.com.au/api/v2/contacts?page=8", "prev": null, "next": "https://app.touchsms.com.au/api/v2/contacts?page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 8, "path": "https://app.touchsms.com.au/api/v2/contacts", "per_page": 50, "to": 50, "total": 400 } }