Skip to content

Commit 877492a

Browse files
committed
start add canvas kit types
1 parent 8e13db9 commit 877492a

File tree

1 file changed

+99
-0
lines changed

1 file changed

+99
-0
lines changed

descriptions/2.11/api.intercom.io.yaml

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10856,6 +10856,105 @@ paths:
1085610856
user:
1085710857
1085810858
type: user
10859+
"/canvas-kit/initialize":
10860+
post:
10861+
summary: Initialize webhook
10862+
description: Triggered when a user or teammate adds or interacts with the app in various contexts.
10863+
requestBody:
10864+
required: true
10865+
content:
10866+
application/json:
10867+
schema:
10868+
oneOf:
10869+
- $ref: '#/components/schemas/InitializeRequestMessenger'
10870+
- $ref: '#/components/schemas/InitializeRequestInbox'
10871+
responses:
10872+
'200':
10873+
description: Successful response with the initial canvas.
10874+
content:
10875+
application/json:
10876+
schema:
10877+
$ref: '#/components/schemas/CanvasResponse'
10878+
"/canvas-kit/submit":
10879+
post:
10880+
summary: Submit webhook
10881+
description: Triggered when a component with a submit action is interacted with.
10882+
requestBody:
10883+
required: true
10884+
content:
10885+
application/json:
10886+
schema:
10887+
oneOf:
10888+
- $ref: '#/components/schemas/SubmitRequestMessenger'
10889+
- $ref: '#/components/schemas/SubmitRequestInbox'
10890+
responses:
10891+
'200':
10892+
description: Successful response with the updated canvas.
10893+
content:
10894+
application/json:
10895+
schema:
10896+
$ref: '#/components/schemas/CanvasResponse'
10897+
"/canvas-kit/configure":
10898+
post:
10899+
summary: Configure webhook
10900+
description: Triggered when the app is being configured.
10901+
requestBody:
10902+
required: true
10903+
content:
10904+
application/json:
10905+
schema:
10906+
$ref: '#/components/schemas/ConfigureRequest'
10907+
"/canvas-kit/open-sheet":
10908+
post:
10909+
summary: Open Sheet webhook
10910+
description: Triggered when a sheet is opened within the app.
10911+
requestBody:
10912+
required: true
10913+
content:
10914+
application/json:
10915+
schema:
10916+
$ref: '#/components/schemas/OpenSheetRequest'
10917+
responses:
10918+
'200':
10919+
description: Successful response with the sheet content.
10920+
content:
10921+
application/json:
10922+
schema:
10923+
$ref: '#/components/schemas/SheetResponse'
10924+
"/canvas-kit/live-canvas":
10925+
post:
10926+
summary: Live Canvas webhook
10927+
description: Triggered to update the canvas in real-time.
10928+
requestBody:
10929+
required: true
10930+
content:
10931+
application/json:
10932+
schema:
10933+
$ref: '#/components/schemas/LiveCanvasRequest'
10934+
responses:
10935+
'200':
10936+
description: Successful response with the live canvas update.
10937+
content:
10938+
application/json:
10939+
schema:
10940+
$ref: '#/components/schemas/CanvasResponse'
10941+
"/canvas-kit/submit-sheet":
10942+
post:
10943+
summary: Submit Sheet webhook
10944+
description: Triggered when a sheet is submitted within the app.
10945+
requestBody:
10946+
required: true
10947+
content:
10948+
application/json:
10949+
schema:
10950+
$ref: '#/components/schemas/SubmitSheetRequest'
10951+
responses:
10952+
'200':
10953+
description: Successful response after sheet submission.
10954+
content:
10955+
application/json:
10956+
schema:
10957+
$ref: '#/components/schemas/SheetResponse'
1085910958
components:
1086010959
schemas:
1086110960
activity_log:

0 commit comments

Comments
 (0)