Theme switcher

Retrieve a Subscription

Path Parameters

idinteger Required

The unique identifier of the subscription to retrieve.

Response

200
Object

Retrieve a Subscription

Response Attributes

idinteger

Subscription ID

subscription_typestring Required

Subscription type

Enum values:
shipment_trackingpayment_statusinsurance_policyshipmentinsurance_claimorder
statusstring Required

Subscription status. Events are delivered as soon as possible when status is active.

Default value
active
Enum values:
activeinactive
urlstring Required

A secure (HTTPS) web address

payload_formatstring Required

Format of payloads.

Default value
json
Enum values:
jsonxml
auth_typestring Required

How eHub authenticates its calls to your URL.

Enum values:
hmachttp_basic
hmac_shared_secretstring

Shared secret used to sign webhook payloads when auth_type is hmac.

last_pushed_atstring

Time the last subscription push was performed

last_pushed_idinteger

ID of the last pushed entity

error_countinteger

Count of pushes resulting in error. Resets to zero on successful push.

last_response_codeinteger

HTTP status code last returned by URL

last_response_messagestring

Response message resulting from last push attempt.

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot