Show Triggerer Rule - Placewise API

Request

Path Params

rule_id

integer

required

Example:

1

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/triggerer/rules/1' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: '

Responses

🟢200Success

application/json

Body

name

object

required

value

string

required

translations

object

required

event_type

string

required

frequency

object

required

limit

integer

required

minimum

integer

required

rate

integer

required

limit

integer

required

minimum

integer

required

rate

integer

required

paused

boolean

required

data_conditions

object

required

operator

array[string]

required

enum

value

string

required

value_type

array[string]

required

enum

or_value_is_null

boolean

required

audience_id

integer

required

hook_delayed_by_seconds

integer

required

hook_on_checks_failure

boolean

required

excluded_sources

array[string]

required

daily_auto_trigger_at

string

required

hook_type

string

required

options

object

required

rewards_api

object

required

mesages_api

object

required

offers_api

object

required

slack

object

required

url

object

required

Example

{
    "rule": {
        "name": {
            "value": "Use coupon from collection \"Valentines\"",
            "translations": {
                "pl": "Użycie kuponu z kolekcji \"Walentynki\""
            }
        },
        "event_type": "string",
        "frequency": {
            "limit": 1,
            "minimum": 1,
            "rate": 1
        },
        "limit": 1,
        "minimum": 1,
        "rate": 1,
        "paused": false,
        "data_conditions": {
            "operator": [
                "EQUAL",
                "GREATER",
                "LOWER",
                "EQUALS_OR_GREATER",
                "EQUALS_OR_LOWER",
                "IS_GIVEN",
                "IS_NOT_GIVEN",
                "NOT_EQUALS",
                "IN",
                "NOT_IN"
            ],
            "value": "string",
            "value_type": [
                "STRING",
                "NUMBER",
                "BOOLEAN",
                "ID",
                "ARRAY_OF_STRINGS",
                "ARRAY_OF_NUMBERS",
                "ARRAY_OF_IDS"
            ],
            "or_value_is_null": false
        },
        "audience_id": 1,
        "hook_delayed_by_seconds": 100,
        "hook_on_checks_failure": false,
        "excluded_sources": [],
        "daily_auto_trigger_at": "12:00",
        "hook_type": "string",
        "options": {
            "rewards_api": {
                "grant_points": 3,
                "points_function": "if (eventData.amount > 100) {eventData.amount * 2} else if (eventData.amount > 50 && eventTime > Date.parse('2024-09-01')) {20} else {0}"
            },
            "mesages_api": {
                "message_id": 1
            },
            "offers_api": {
                "offer_id": 389123,
                "offer_usable_for_seconds": 3600
            },
            "slack": {
                "channel": "string",
                "webhook_url": "https://url.com"
            },
            "url": {
                "webhook_url": "https://url.com",
                "webhook_secret": "string"
            }
        }
    }
}