Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions descriptions/2.11/api.intercom.io.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10856,6 +10856,105 @@
user:
email: [email protected]
type: user
"/canvas-kit/initialize":
post:
summary: Initialize webhook
description: Triggered when a user or teammate adds or interacts with the app in various contexts.
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/InitializeRequestMessenger'

Check warning on line 10869 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

10869:17 [indentation] wrong indentation: expected 14 but found 16
- $ref: '#/components/schemas/InitializeRequestInbox'
responses:
'200':
description: Successful response with the initial canvas.
content:
application/json:
schema:
$ref: '#/components/schemas/CanvasResponse'
"/canvas-kit/submit":
post:
summary: Submit webhook
description: Triggered when a component with a submit action is interacted with.
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/SubmitRequestMessenger'

Check warning on line 10888 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

10888:17 [indentation] wrong indentation: expected 14 but found 16
- $ref: '#/components/schemas/SubmitRequestInbox'
responses:
'200':
description: Successful response with the updated canvas.
content:
application/json:
schema:
$ref: '#/components/schemas/CanvasResponse'
"/canvas-kit/configure":
post:
summary: Configure webhook
description: Triggered when the app is being configured.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigureRequest'
"/canvas-kit/open-sheet":
post:
summary: Open Sheet webhook
description: Triggered when a sheet is opened within the app.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OpenSheetRequest'
responses:
'200':
description: Successful response with the sheet content.
content:
application/json:
schema:
$ref: '#/components/schemas/SheetResponse'
"/canvas-kit/live-canvas":
post:
summary: Live Canvas webhook
description: Triggered to update the canvas in real-time.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LiveCanvasRequest'
responses:
'200':
description: Successful response with the live canvas update.
content:
application/json:
schema:
$ref: '#/components/schemas/CanvasResponse'
"/canvas-kit/submit-sheet":
post:
summary: Submit Sheet webhook
description: Triggered when a sheet is submitted within the app.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SubmitSheetRequest'
responses:
'200':
description: Successful response after sheet submission.
content:
application/json:
schema:
$ref: '#/components/schemas/SheetResponse'
components:
schemas:
activity_log:
Expand Down Expand Up @@ -10973,7 +11072,7 @@
description: A sentence or two describing the activity.
example: Admin updated the app's name to "My App".
required:
- id

Check warning on line 11075 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11075:9 [indentation] wrong indentation: expected 6 but found 8
- performed_by
- activity_type
activity_log_list:
Expand All @@ -10996,7 +11095,7 @@
items:
"$ref": "#/components/schemas/activity_log"
required:
- type

Check warning on line 11098 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11098:9 [indentation] wrong indentation: expected 6 but found 8
- activity_logs
activity_log_metadata:
title: Activity Log Metadata
Expand Down Expand Up @@ -11071,7 +11170,7 @@
description: Url to get more company resources for this contact
example: "/contacts/5ba682d23d7cf92bef87bfd4/notes"
required:
- type

Check warning on line 11173 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11173:9 [indentation] wrong indentation: expected 6 but found 8
- id
- url
admin:
Expand All @@ -11081,7 +11180,7 @@
- Admins
description: Admins are teammate accounts that have access to a workspace.
required:
- id

Check warning on line 11183 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11183:9 [indentation] wrong indentation: expected 6 but found 8
- name
- email
- job_title
Expand Down Expand Up @@ -11160,7 +11259,7 @@
items:
"$ref": "#/components/schemas/admin"
required:
- type

Check warning on line 11262 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11262:9 [indentation] wrong indentation: expected 6 but found 8
- admins
admin_priority_level:
title: Admin Priority Level
Expand Down Expand Up @@ -11373,7 +11472,7 @@
nullable: true
description: App that the admin belongs to.
required:
- type

Check warning on line 11475 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11475:9 [indentation] wrong indentation: expected 6 but found 8
- id
- name
- email
Expand Down Expand Up @@ -11442,7 +11541,7 @@
content_sources:
"$ref": "#/components/schemas/content_sources_list"
required:
- source_type

Check warning on line 11544 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11544:9 [indentation] wrong indentation: expected 6 but found 8
app:
title: App
type: object
Expand Down Expand Up @@ -11478,7 +11577,7 @@
description: Whether or not the app uses identity verification.
example: false
required:
- type

Check warning on line 11580 in descriptions/2.11/api.intercom.io.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI Descriptions

11580:9 [indentation] wrong indentation: expected 6 but found 8
- id_code
- name
- region
Expand Down