Skip to content

Commit 827b451

Browse files
varadarajan-twvaradarajan-tw
committed
Adds postman collection and event-generator
1 parent bbc9237 commit 827b451

File tree

4 files changed

+823
-0
lines changed

4 files changed

+823
-0
lines changed

‎action-destinations-api-environment.http‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
### Environment Variables
2+
@host = http://localhost:3000
3+
@actionSlug = yourActionSlug
4+
@field = yourDynamicField
5+
@hookName = yourHookName
6+
@fieldKey = yourFieldKey
7+
8+
### Get Destination Manifest
9+
GET {{host}}/manifest
10+
Accept: application/json
11+
12+
### Delete Destination
13+
POST {{host}}/delete
14+
Content-Type: application/json
15+
16+
{
17+
"payload": {},
18+
"settings": {}
19+
}
20+
21+
### Authenticate
22+
POST {{host}}/authenticate
23+
Content-Type: application/json
24+
25+
{
26+
"settings": {
27+
"apiKey": "your-api-key"
28+
}
29+
}
30+
31+
### Create Audience
32+
POST {{host}}/createAudience
33+
Content-Type: application/json
34+
35+
{
36+
"settings": {
37+
"apiKey": "your-api-key"
38+
},
39+
"audienceSettings": {
40+
"name": "New Audience"
41+
}
42+
}
43+
44+
### Get Audience
45+
POST {{host}}/getAudience
46+
Content-Type: application/json
47+
48+
{
49+
"settings": {
50+
"apiKey": "your-api-key"
51+
},
52+
"audienceId": "your-audience-id"
53+
}
54+
55+
### Refresh Access Token
56+
POST {{host}}/refreshAccessToken
57+
Content-Type: application/json
58+
59+
{
60+
"settings": {
61+
"refreshToken": "your-refresh-token"
62+
}
63+
}
64+
65+
### Execute Action
66+
POST {{host}}/{{actionSlug}}
67+
Content-Type: application/json
68+
69+
{
70+
"payload": {
71+
"event": "Purchase",
72+
"userId": "user123",
73+
"properties": {
74+
"price": 99.99,
75+
"productId": "prod-456"
76+
}
77+
},
78+
"settings": {
79+
"apiKey": "your-api-key"
80+
},
81+
"mapping": {
82+
"userId": "$.userId",
83+
"event": "$.event",
84+
"price": "$.properties.price"
85+
},
86+
"auth": {},
87+
"features": {},
88+
"subscriptionMetadata": {}
89+
}
90+
91+
### Execute Dynamic Field
92+
POST {{host}}/{{actionSlug}}/{{field}}
93+
Content-Type: application/json
94+
95+
{
96+
"settings": {
97+
"apiKey": "your-api-key"
98+
},
99+
"payload": {},
100+
"page": 1,
101+
"auth": {},
102+
"audienceSettings": {},
103+
"dynamicFieldContext": {}
104+
}
105+
106+
### Execute Hook
107+
POST {{host}}/{{actionSlug}}/hooks/{{hookName}}
108+
Content-Type: application/json
109+
110+
{
111+
"settings": {
112+
"apiKey": "your-api-key"
113+
},
114+
"payload": {},
115+
"page": 1,
116+
"auth": {},
117+
"audienceSettings": {},
118+
"hookInputs": {
119+
"param1": "value1"
120+
},
121+
"hookOutputs": {}
122+
}
123+
124+
### Execute Dynamic Hook Input Field
125+
POST {{host}}/{{actionSlug}}/hooks/{{hookName}}/dynamic/{{fieldKey}}
126+
Content-Type: application/json
127+
128+
{
129+
"settings": {
130+
"apiKey": "your-api-key"
131+
},
132+
"payload": {},
133+
"page": 1,
134+
"auth": {},
135+
"audienceSettings": {},
136+
"hookInputs": {},
137+
"dynamicFieldContext": {}
138+
}

‎action-destinations-api.http‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
### Get Destination Manifest
2+
GET http://localhost:3000/manifest
3+
Accept: application/json
4+
5+
### Delete Destination
6+
POST http://localhost:3000/delete
7+
Content-Type: application/json
8+
9+
{
10+
"payload": {},
11+
"settings": {}
12+
}
13+
14+
### Authenticate
15+
POST http://localhost:3000/authenticate
16+
Content-Type: application/json
17+
18+
{
19+
"settings": {}
20+
}
21+
22+
### Create Audience
23+
POST http://localhost:3000/createAudience
24+
Content-Type: application/json
25+
26+
{}
27+
28+
### Get Audience
29+
POST http://localhost:3000/getAudience
30+
Content-Type: application/json
31+
32+
{}
33+
34+
### Refresh Access Token
35+
POST http://localhost:3000/refreshAccessToken
36+
Content-Type: application/json
37+
38+
{
39+
"settings": {}
40+
}
41+
42+
### Execute Action
43+
# @name executeAction
44+
POST http://localhost:3000/{{actionSlug}}
45+
Content-Type: application/json
46+
47+
{
48+
"payload": {},
49+
"settings": {},
50+
"mapping": {},
51+
"auth": {},
52+
"features": {},
53+
"subscriptionMetadata": {}
54+
}
55+
56+
### Execute Dynamic Field
57+
# @name executeDynamicField
58+
POST http://localhost:3000/{{actionSlug}}/{{field}}
59+
Content-Type: application/json
60+
61+
{
62+
"settings": {},
63+
"payload": {},
64+
"page": 1,
65+
"auth": {},
66+
"audienceSettings": {},
67+
"dynamicFieldContext": {}
68+
}
69+
70+
### Execute Hook
71+
# @name executeHook
72+
POST http://localhost:3000/{{actionSlug}}/hooks/{{hookName}}
73+
Content-Type: application/json
74+
75+
{
76+
"settings": {},
77+
"payload": {},
78+
"page": 1,
79+
"auth": {},
80+
"audienceSettings": {},
81+
"hookInputs": {},
82+
"hookOutputs": {}
83+
}
84+
85+
### Execute Dynamic Hook Input Field
86+
# @name executeDynamicHookInputField
87+
POST http://localhost:3000/{{actionSlug}}/hooks/{{hookName}}/dynamic/{{fieldKey}}
88+
Content-Type: application/json
89+
90+
{
91+
"settings": {},
92+
"payload": {},
93+
"page": 1,
94+
"auth": {},
95+
"audienceSettings": {},
96+
"hookInputs": {},
97+
"dynamicFieldContext": {}
98+
}

0 commit comments

Comments
 (0)