#Get subscription

Get a subscription.

#Method

GET

#Path

/webhook-subscriptions/[subscription_id]

#Path parameter

NameValueRequired?
subscription_idSubscription IDYes

#Response

#HTTP status codes

CodeRemarks
200Request was successful.
400Validation error or request body was incorrectly formatted.
401Authentication failed. Check apikey header.
404Requested API endpoint not found.
429The rate limit has been reached.
500-511There was a problem processing the request on our server. Try again later.

#Response object

NameValueRemarks
statussuccess or error-
errorsArray of object { msg: [error detail] }Only present when status is error.
dataSubscription object. See belowOnly present when status is success

#Subscription object

NameValue
idSubscription ID
channel_keyChannel key associated to this webhook
created_atMilliseconds timestamp of when the subscription was created
platformPlatform hosting the endpoint (value provided by the caller when creating the subscription)
providertwlo (for Twilio SMS),
twlowa (for Twilio WhatsApp),
gswa (for Gupshup WhatsApp)
statusStatus of the webhook subscription. active or paused
subscriber_reference_idUnique identifier for the subscription (value provided by the caller when creating the subscription)
trigger_directionValue is always incoming
webhook_urlWebhook endpoint URL

#Code sample

curl --location --request GET 'https://api.sociocs.com/webhook-subscriptions/ABC1234567890XYZ' \ --header 'apikey: your_api_key' \