Create filter

Create a webhook filter. This webhook filter can be used with multiple webhook targets. An event type cannot be used twice in the same webhook filter. For every event name you can subscribe to, see Webhook events.

Recipes
🔔
Set up webhooks end to end
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

How to use this endpoint

To see an example request, click Examples in the payload on the right.

📘

Use event names exactly as listed in Webhook events, for example review_create or swell/points/earned. Topic names aren't validated: a misspelled topic is saved, but the filter never matches an event.

Path Params
string
required

The store ID (app_key)

Body Params
webhook_filter
object
required

The events to include. See Webhook events for every event name.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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