Theme switcher

Create a Subscription

Body Parameters

subscription_typestring Required

Subscription type

Enum values:
shipment_trackingpayment_statusorder
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

Approach used for authenticating requests.

Enum values:
hmachttp_basic
hmac_shared_secretstring

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

http_usernamestring

Used for webhook calls when auth_type is HTTP_BASIC.

http_passwordstring

Used for webhook calls when auth_type is HTTP_BASIC.

entity_idsarray

Provide multiple values in new lines. List of entity IDs associated with the subscription. For an 'orders' subscription, this would hold the IDs of any order_stores you want to receive updates for.

Response

201
Object

Create 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.

Was this section helpful?

POST

/

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