Get a webhook subscription

Returns one of your webhook subscriptions.

GET

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

Authorization

basicAuth
HTTP
required

Path parameters

webhookSubscription
integer
required
Webhook subscription ID.

Returns

200

The subscription.

JSON

data
optional
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
}

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

403

The resource exists but does not belong to you, or you lack permission.

JSON

message
string
required

404

The resource does not exist.

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" } }