Create a New Subscription

Creates a notification subscription. When the Spreetail API generates an event with the provided eventType value, a message will be send to your webhookUri via POST. You may create multiple subscriptions for any of the valid eventType values.

Supported Event Types

Refer to the Webhook Notifications guide for currently supported Event Types.

Webhook URI

All notification messages will be sent to your webhookUri value via POST. Your endpoint must return a 200 OK message in response - any other response or timeout will be treated as a failed send attempt and will be retried.

For more details, see the Webhook Notifications guide.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

One of the supported event types.

string
required

URI for the endpoint that will receive the notification messages for the given eventType. URI must begin with https:// or http://

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

401

Unauthorized

403

Forbidden

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json