Subscribe to Tracking Plan changes with webhooks

3 minute read
On this page
What's next?

After setting up Webhook integration in Tracking Plan Publishing, your endpoint provided there will be called with a JSON payload representing the state of your tracking plan when your tracking plan is published.

You can examine and download the exact JSON in the Publishing tab of your Avo workspace.

To see your exact Webhook payload in your Avo workspace choose Tracking plan - Publishing in the sidebar, then pick you Webhook in the menu and expand the Payload preview section.

The format is documented here, an example payload is:

JSON
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
{
"name": "Avo",
"events": [
{
"id": "_",
"name": "Debugger Started",
"description": "Sent when the web debugger is started.",
"tags": [],
"categories": [
"categoryId"
],
"rules": {
"$schema": "http://json-schema.org/draft-06/schema#",
"type": "object",
"required": [
"properties",
"nameMapping"
],
"properties": {
"properties": {
"type": "object",
"properties": {
"Property Name 1": {
"id": "_",
"description": "Describes from where the debugger was started.",
"type": "string",
"nameMapping": [
{
"name": "Mapped Property Name",
"destinationId": "all" | "anotherDestinationId"
}
]
},
"Property Name 2": {
"id": "_",
"description": "",
"type": "string",
"enum": [
"Option 1",
"Option 2"
]
}
},
"additionalProperties": false,
"required": [
"Property Name 1",
"Property Name 2"
]
}
},
"nameMapping": [
{
"name": "Mapped Event Name",
"destinationId": "all" | "anotherDestinationId"
}
]
}
}
],
"metrics": {
"metricId": {
"id": "metricId",
"name": "Proportion of weekly active workspaces with published integrations",
"description": "",
"categories": [
"categoryId"
],
"type": "Proportion",
"items": [
{
"eventId": "_",
"where": [
{
"propertyId": "_",
"operation": "greater",
"values": [
0
]
}
],
"groupBy": []
},
{
"eventId": "_",
"where": [],
"groupBy": []
}
]
},
"anotherMethicId": {
"id": "anotherMethicId",
"name": "Number of integrations – segmented by integration type",
"description": "",
"categories": [
"categoryId"
],
"type": "EventSegmentation",
"items": [
{
"eventId": "_",
"where": [],
"groupBy": [
{
"propertyId": "_"
}
]
}
]
},
"yetAnotherMetricId": {
"id": "yetAnotherMetricId",
"name": "Data Design Funnel",
"description": "",
"categories": [
"categoryId"
],
"type": "Funnel",
"items": [
{
"eventId": "_",
"where": [],
"groupBy": []
},
{
"eventId": "_",
"where": [],
"groupBy": []
},
{
"eventId": "_",
"where": [],
"groupBy": []
},
{
"eventId": "_",
"where": [],
"groupBy": []
},
{
"eventId": "_",
"where": [],
"groupBy": []
}
]
}
},
"sources": {
"sourceId": {
"id": "sourceId",
"name": "Web",
"programmingLanguage": "Reason_V2",
"developmentPlatform": "Web",
"destinations": [
"destinationId",
"anotherdestinationId"
]
},
"anotherSourceId": {
"id": "anotherSourceId",
"name": "Functions",
"programmingLanguage": "Reason_V2",
"developmentPlatform": "Node",
"destinations": [
"destinationId",
"anotherdestinationId"
]
}
},
"destinations": {
"destinationId": {
"id": "mixpanel",
"name": "Web Mixpanel",
"type": "Mixpanel"
},
"anotherDestinationId": {
"id": "anotherDestinationId",
"name": "Backend Segment",
"type": "Segment"
}
},
"categories": {
"categoryId": {
"id": "categoryId",
"name": "Onboarding",
"description": "",
"metrics": [
"metricId",
"anotherMetricId"
],
"events": [
"eventId",
"anotherEventId"
]
},
"anotherCategoryId": {
"id": "anotherCategoryId",
"name": "CLI",
"description": "",
"metrics": [
"metricId",
"anotherMetricId"
],
"events": [
"eventId",
"anotherEventId"
]
}
},
"context": {
"publishInfo": {
"branchId": "master",
"branchName": "main",
"integrationId": "_",
"integrationName": "Webhook",
"publishDate": "Fri, 18 Jun 2021 13:54:01 GMT",
"publishMethod": {
"type": "Manual"
}
}
}
}

What's next?

Now when you've set up a webhook we recommend to integrate the Avo Inspector.

On this page
What's next?