API Reference

Update a Subscription

The Update a Subscription endpoint allows you to modify an existing webhook subscription. You can update details such as the callback URL, the types of events you're subscribed to, or the description of the subscription. This helps ensure your webhook remains aligned with your current operational needs.

This endpoint gives you flexibility to keep your webhook subscriptions up-to-date with your current needs, ensuring that your system stays in sync with real-time shipment or payment status updates.

Path Parameters

idinteger Required

statusstring

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

Enum values:

active

inactive

urlstring

A secure (HTTPS) web address

payload_formatstring

Format of payloads.

Enum values:

json

xml

auth_typestring

Approach used for authenticating requests.

Enum values:

hmac

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

rewind_to_datestring

Resets the 'last pushed' pointer to the first entity on given date, resulting in the subscription re-sending all entities created since then. Maximum of 30 days in the past.

Body Parameters

rewind_to_datestring

Resets the 'last pushed' pointer to the first entity on given date, resulting in the subscription re-sending all entities created since then. Maximum of 30 days in the past.

entity_idsarray

Provide multiple vales in new lines. List of entity IDs associated with the subscription.

Response

200

Object

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

Sections

Update a Subscription

Path Parameters

Body Parameters

Response

Response Attributes

Response

Ask an AI

Code with AI