Skip to navigation
API ReferenceWebhooks

Replace a webhook subscription

Available by request

Webhooks are only available for certain clients. Contact your Rush Order representative to have them enabled. Creating or changing subscriptions with an API key must also be enabled for your account; otherwise this returns 403.

Replaces every field of the subscription. EventTypes replaces the current list rather than adding to it. To change only some fields, use PATCH /webhooks/subscriptions/{id}.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

idintegerRequired
The subscription ID.

Headers

RushOrderMomCodestringRequired
All requests require the header to contain RushOrderMomCode, a 3 character string that represents the client internally in Rush Order. This should be given to you by Rush Order.

Request

This endpoint expects an object.
NamestringRequired
Must be unique among your subscriptions.
TargetUrlstringRequired

Where deliveries are sent. Must use https on port 443, have a public host name that resolves only to public IP addresses, contain no user name or password, and be at most 2048 characters.

ActivebooleanRequired
Omitting it sets it to false, which pauses the subscription.
EventTypeslist of stringsRequired

Event codes to deliver, such as order.shipped. At least one is required. See GET /webhooks/event-types for the list.

DescriptionstringOptional

Response

Success
IdintegerOptional
NamestringOptional
TargetUrlstringOptional
Descriptionstring or nullOptional
ActivebooleanOptional
Inactive subscriptions receive no deliveries.
CreatedAtdatetimeOptional
ModifiedAtdatetime or nullOptional
EventTypeslist of stringsOptional
PreviousSecretExpiresAtdatetime or nullOptional
Set after a secret rotation while the previous secret is still signing deliveries.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error