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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

How to use this endpoint

You can create this filter once for your app, using any valid access token.

📘

Use topic names exactly as listed in Yotpo Events and Introduction to Loyalty 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

Your app's client ID: the 32-character ID you received when you registered your app, the same value you send as client_id to Generate Access Token. It isn't the numeric app ID: that returns 403 {"message": "Forbidden"}.

Body Params
webhook_filter
object
required

Select from the list of event here

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json