From e9872edddc2e0c04216536eaabf1b45a4f5ec9d4 Mon Sep 17 00:00:00 2001 From: Keith Stenson <147769+kstenson@users.noreply.github.com> Date: Fri, 6 Nov 2026 12:39:31 +0000 Subject: [PATCH 1/4] Document conversation stream token endpoints for 2.16, 2.17 and Preview Co-Authored-By: Claude Sonnet 5.5 --- descriptions/0/api.intercom.io.yaml | 193 +++++++++++++++++++++++++ descriptions/2.16/api.intercom.io.yaml | 193 +++++++++++++++++++++++++ descriptions/2.17/api.intercom.io.yaml | 193 +++++++++++++++++++++++++ 3 files changed, 579 insertions(+) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 3c8acdc2..55596e88 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -22347,6 +22347,123 @@ paths: message: Active subscription needed. schema: "$ref": "#/components/schemas/error" + "/conversations/stream/token": + post: + summary: Create a conversation stream token + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: createConversationStreamToken + description: | + Issue a token that a contact's client uses to subscribe to a realtime stream of that contact's conversation events. + + Tokens are short-lived, so call this endpoint again before `expires_at` to get a fresh one. Use the `revoke` link in the response to end every active token for the contact. + + Requires the `read_conversations` permission. + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_conversation_stream_token_request" + examples: + successful: + summary: successful + value: + external_id: contact-1234 + responses: + '200': + description: Token issued + content: + application/json: + examples: + successful: + value: + type: conversation_stream_token + expires_at: 1731241200 + stream: + provider: ably + url: main.realtime.ably.net + channel: conversation_stream:abc123:6710a1b2c3d4e5f6a7b8c9d0 + token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleGFtcGxlIjoidG9rZW4ifQ.c2lnbmF0dXJl + links: + self: + href: https://api.intercom.io/conversations/stream/token + method: POST + revoke: + href: https://api.intercom.io/conversations/stream/token?external_id=contact-1234 + method: DELETE + schema: + "$ref": "#/components/schemas/conversation_stream_token" + '400': + description: "`external_id` is missing" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7d3e1f0a-5b2c-4a96-8c41-0e9f6b2d7a35 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: The access token is limited to the conversations of the teammate who installed the app + '404': + description: The contact was not found, or the conversation stream is not available for the workspace + delete: + summary: Revoke conversation stream tokens + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: external_id + in: query + required: true + description: The external ID of the contact whose tokens to revoke. + example: contact-1234 + schema: + type: string + tags: + - Conversations + operationId: revokeConversationStreamTokens + description: | + Revoke every active conversation stream token for a contact. Call this when the contact signs out or you suspect a token has been exposed. + + Requires the `read_conversations` permission. + responses: + '204': + description: Tokens revoked + '400': + description: "`external_id` is missing" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 2c8a4e6b-9f1d-4b73-a5e0-6d1c3f8b9a47 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: The access token is limited to the conversations of the teammate who installed the app + '404': + description: The contact was not found, or the conversation stream is not available for the workspace + '502': + description: The realtime provider did not confirm the revocation. Retry the request. "/conversations/attributes": get: summary: List all conversation attributes @@ -45813,6 +45930,82 @@ components: format: date-time description: The time when the conversation was deleted. example: 1734537745 + create_conversation_stream_token_request: + title: Create conversation stream token request + type: object + required: + - external_id + properties: + external_id: + type: string + description: The external ID of the contact to issue a token for. + example: contact-1234 + conversation_stream_token: + title: Conversation stream token + type: object + x-tags: + - Conversations + description: A token that lets a contact's client subscribe to a realtime stream of their conversation events. + properties: + type: + type: string + description: String representing the object's type. Always has the value `conversation_stream_token`. + enum: + - conversation_stream_token + example: conversation_stream_token + expires_at: + type: integer + format: date-time + description: The time the token expires, as a UNIX timestamp. + example: 1731241200 + stream: + type: object + description: What the client needs to connect to the stream. + properties: + provider: + type: string + description: The realtime provider that delivers the stream. + example: ably + url: + type: string + description: The host to connect to. + example: main.realtime.ably.net + channel: + type: string + description: The channel to subscribe to. + example: conversation_stream:abc123:6710a1b2c3d4e5f6a7b8c9d0 + token: + type: string + description: The token to connect with. + example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleGFtcGxlIjoidG9rZW4ifQ.c2lnbmF0dXJl + links: + type: object + description: The requests you can make with this token. + properties: + self: + type: object + description: The request that issues a new token for the contact. + properties: + href: + type: string + description: The URL to request. + example: https://api.intercom.io/conversations/stream/token + method: + type: string + description: The HTTP method to use. + example: POST + revoke: + type: object + description: The request that revokes every active token for the contact. + properties: + href: + type: string + description: The URL to request. + example: https://api.intercom.io/conversations/stream/token?external_id=contact-1234 + method: + type: string + description: The HTTP method to use. + example: DELETE deleted_conversation_list: title: Conversations type: object diff --git a/descriptions/2.16/api.intercom.io.yaml b/descriptions/2.16/api.intercom.io.yaml index df34a751..15a4c67e 100644 --- a/descriptions/2.16/api.intercom.io.yaml +++ b/descriptions/2.16/api.intercom.io.yaml @@ -14308,6 +14308,123 @@ paths: message: Requested resource is not available in current API version. schema: "$ref": "#/components/schemas/error" + "/conversations/stream/token": + post: + summary: Create a conversation stream token + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: createConversationStreamToken + description: | + Issue a token that a contact's client uses to subscribe to a realtime stream of that contact's conversation events. + + Tokens are short-lived, so call this endpoint again before `expires_at` to get a fresh one. Use the `revoke` link in the response to end every active token for the contact. + + Requires the `read_conversations` permission. + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_conversation_stream_token_request" + examples: + successful: + summary: successful + value: + external_id: contact-1234 + responses: + '200': + description: Token issued + content: + application/json: + examples: + successful: + value: + type: conversation_stream_token + expires_at: 1731241200 + stream: + provider: ably + url: main.realtime.ably.net + channel: conversation_stream:abc123:6710a1b2c3d4e5f6a7b8c9d0 + token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleGFtcGxlIjoidG9rZW4ifQ.c2lnbmF0dXJl + links: + self: + href: https://api.intercom.io/conversations/stream/token + method: POST + revoke: + href: https://api.intercom.io/conversations/stream/token?external_id=contact-1234 + method: DELETE + schema: + "$ref": "#/components/schemas/conversation_stream_token" + '400': + description: "`external_id` is missing" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7d3e1f0a-5b2c-4a96-8c41-0e9f6b2d7a35 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: The access token is limited to the conversations of the teammate who installed the app + '404': + description: The contact was not found, or the conversation stream is not available for the workspace + delete: + summary: Revoke conversation stream tokens + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: external_id + in: query + required: true + description: The external ID of the contact whose tokens to revoke. + example: contact-1234 + schema: + type: string + tags: + - Conversations + operationId: revokeConversationStreamTokens + description: | + Revoke every active conversation stream token for a contact. Call this when the contact signs out or you suspect a token has been exposed. + + Requires the `read_conversations` permission. + responses: + '204': + description: Tokens revoked + '400': + description: "`external_id` is missing" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 2c8a4e6b-9f1d-4b73-a5e0-6d1c3f8b9a47 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: The access token is limited to the conversations of the teammate who installed the app + '404': + description: The contact was not found, or the conversation stream is not available for the workspace + '502': + description: The realtime provider did not confirm the revocation. Retry the request. "/conversations/attributes": get: summary: List all conversation attributes @@ -27948,6 +28065,82 @@ components: format: date-time description: The time when the conversation was deleted. example: 1734537745 + create_conversation_stream_token_request: + title: Create conversation stream token request + type: object + required: + - external_id + properties: + external_id: + type: string + description: The external ID of the contact to issue a token for. + example: contact-1234 + conversation_stream_token: + title: Conversation stream token + type: object + x-tags: + - Conversations + description: A token that lets a contact's client subscribe to a realtime stream of their conversation events. + properties: + type: + type: string + description: String representing the object's type. Always has the value `conversation_stream_token`. + enum: + - conversation_stream_token + example: conversation_stream_token + expires_at: + type: integer + format: date-time + description: The time the token expires, as a UNIX timestamp. + example: 1731241200 + stream: + type: object + description: What the client needs to connect to the stream. + properties: + provider: + type: string + description: The realtime provider that delivers the stream. + example: ably + url: + type: string + description: The host to connect to. + example: main.realtime.ably.net + channel: + type: string + description: The channel to subscribe to. + example: conversation_stream:abc123:6710a1b2c3d4e5f6a7b8c9d0 + token: + type: string + description: The token to connect with. + example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleGFtcGxlIjoidG9rZW4ifQ.c2lnbmF0dXJl + links: + type: object + description: The requests you can make with this token. + properties: + self: + type: object + description: The request that issues a new token for the contact. + properties: + href: + type: string + description: The URL to request. + example: https://api.intercom.io/conversations/stream/token + method: + type: string + description: The HTTP method to use. + example: POST + revoke: + type: object + description: The request that revokes every active token for the contact. + properties: + href: + type: string + description: The URL to request. + example: https://api.intercom.io/conversations/stream/token?external_id=contact-1234 + method: + type: string + description: The HTTP method to use. + example: DELETE deleted_conversation_list: title: Conversations type: object diff --git a/descriptions/2.17/api.intercom.io.yaml b/descriptions/2.17/api.intercom.io.yaml index 77140dc1..ebfbbcbc 100644 --- a/descriptions/2.17/api.intercom.io.yaml +++ b/descriptions/2.17/api.intercom.io.yaml @@ -22014,6 +22014,123 @@ paths: message: Active subscription needed. schema: "$ref": "#/components/schemas/error" + "/conversations/stream/token": + post: + summary: Create a conversation stream token + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: createConversationStreamToken + description: | + Issue a token that a contact's client uses to subscribe to a realtime stream of that contact's conversation events. + + Tokens are short-lived, so call this endpoint again before `expires_at` to get a fresh one. Use the `revoke` link in the response to end every active token for the contact. + + Requires the `read_conversations` permission. + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_conversation_stream_token_request" + examples: + successful: + summary: successful + value: + external_id: contact-1234 + responses: + '200': + description: Token issued + content: + application/json: + examples: + successful: + value: + type: conversation_stream_token + expires_at: 1731241200 + stream: + provider: ably + url: main.realtime.ably.net + channel: conversation_stream:abc123:6710a1b2c3d4e5f6a7b8c9d0 + token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleGFtcGxlIjoidG9rZW4ifQ.c2lnbmF0dXJl + links: + self: + href: https://api.intercom.io/conversations/stream/token + method: POST + revoke: + href: https://api.intercom.io/conversations/stream/token?external_id=contact-1234 + method: DELETE + schema: + "$ref": "#/components/schemas/conversation_stream_token" + '400': + description: "`external_id` is missing" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7d3e1f0a-5b2c-4a96-8c41-0e9f6b2d7a35 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: The access token is limited to the conversations of the teammate who installed the app + '404': + description: The contact was not found, or the conversation stream is not available for the workspace + delete: + summary: Revoke conversation stream tokens + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: external_id + in: query + required: true + description: The external ID of the contact whose tokens to revoke. + example: contact-1234 + schema: + type: string + tags: + - Conversations + operationId: revokeConversationStreamTokens + description: | + Revoke every active conversation stream token for a contact. Call this when the contact signs out or you suspect a token has been exposed. + + Requires the `read_conversations` permission. + responses: + '204': + description: Tokens revoked + '400': + description: "`external_id` is missing" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 2c8a4e6b-9f1d-4b73-a5e0-6d1c3f8b9a47 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: The access token is limited to the conversations of the teammate who installed the app + '404': + description: The contact was not found, or the conversation stream is not available for the workspace + '502': + description: The realtime provider did not confirm the revocation. Retry the request. "/conversations/attributes": get: summary: List all conversation attributes @@ -40141,6 +40258,82 @@ components: format: date-time description: The time when the conversation was deleted. example: 1734537745 + create_conversation_stream_token_request: + title: Create conversation stream token request + type: object + required: + - external_id + properties: + external_id: + type: string + description: The external ID of the contact to issue a token for. + example: contact-1234 + conversation_stream_token: + title: Conversation stream token + type: object + x-tags: + - Conversations + description: A token that lets a contact's client subscribe to a realtime stream of their conversation events. + properties: + type: + type: string + description: String representing the object's type. Always has the value `conversation_stream_token`. + enum: + - conversation_stream_token + example: conversation_stream_token + expires_at: + type: integer + format: date-time + description: The time the token expires, as a UNIX timestamp. + example: 1731241200 + stream: + type: object + description: What the client needs to connect to the stream. + properties: + provider: + type: string + description: The realtime provider that delivers the stream. + example: ably + url: + type: string + description: The host to connect to. + example: main.realtime.ably.net + channel: + type: string + description: The channel to subscribe to. + example: conversation_stream:abc123:6710a1b2c3d4e5f6a7b8c9d0 + token: + type: string + description: The token to connect with. + example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleGFtcGxlIjoidG9rZW4ifQ.c2lnbmF0dXJl + links: + type: object + description: The requests you can make with this token. + properties: + self: + type: object + description: The request that issues a new token for the contact. + properties: + href: + type: string + description: The URL to request. + example: https://api.intercom.io/conversations/stream/token + method: + type: string + description: The HTTP method to use. + example: POST + revoke: + type: object + description: The request that revokes every active token for the contact. + properties: + href: + type: string + description: The URL to request. + example: https://api.intercom.io/conversations/stream/token?external_id=contact-1234 + method: + type: string + description: The HTTP method to use. + example: DELETE deleted_conversation_list: title: Conversations type: object From ceda9bbec3005cb4cf75d193ee4323c2e996f937 Mon Sep 17 00:00:00 2001 From: Keith Stenson <147769+kstenson@users.noreply.github.com> Date: Fri, 6 Nov 2026 12:47:27 +0000 Subject: [PATCH 2/4] Mark conversation stream token endpoints as limited availability Co-Authored-By: Claude Sonnet 5.5 --- descriptions/0/api.intercom.io.yaml | 4 ++++ descriptions/2.16/api.intercom.io.yaml | 4 ++++ descriptions/2.17/api.intercom.io.yaml | 4 ++++ 3 files changed, 12 insertions(+) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 55596e88..48f53d0f 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -22359,6 +22359,8 @@ paths: - Conversations operationId: createConversationStreamToken description: | + Limited availability: this endpoint is enabled per workspace. Contact Intercom to request access. + Issue a token that a contact's client uses to subscribe to a realtime stream of that contact's conversation events. Tokens are short-lived, so call this endpoint again before `expires_at` to get a fresh one. Use the `revoke` link in the response to end every active token for the contact. @@ -22436,6 +22438,8 @@ paths: - Conversations operationId: revokeConversationStreamTokens description: | + Limited availability: this endpoint is enabled per workspace. Contact Intercom to request access. + Revoke every active conversation stream token for a contact. Call this when the contact signs out or you suspect a token has been exposed. Requires the `read_conversations` permission. diff --git a/descriptions/2.16/api.intercom.io.yaml b/descriptions/2.16/api.intercom.io.yaml index 15a4c67e..fdefd683 100644 --- a/descriptions/2.16/api.intercom.io.yaml +++ b/descriptions/2.16/api.intercom.io.yaml @@ -14320,6 +14320,8 @@ paths: - Conversations operationId: createConversationStreamToken description: | + Limited availability: this endpoint is enabled per workspace. Contact Intercom to request access. + Issue a token that a contact's client uses to subscribe to a realtime stream of that contact's conversation events. Tokens are short-lived, so call this endpoint again before `expires_at` to get a fresh one. Use the `revoke` link in the response to end every active token for the contact. @@ -14397,6 +14399,8 @@ paths: - Conversations operationId: revokeConversationStreamTokens description: | + Limited availability: this endpoint is enabled per workspace. Contact Intercom to request access. + Revoke every active conversation stream token for a contact. Call this when the contact signs out or you suspect a token has been exposed. Requires the `read_conversations` permission. diff --git a/descriptions/2.17/api.intercom.io.yaml b/descriptions/2.17/api.intercom.io.yaml index ebfbbcbc..2bc6ab84 100644 --- a/descriptions/2.17/api.intercom.io.yaml +++ b/descriptions/2.17/api.intercom.io.yaml @@ -22026,6 +22026,8 @@ paths: - Conversations operationId: createConversationStreamToken description: | + Limited availability: this endpoint is enabled per workspace. Contact Intercom to request access. + Issue a token that a contact's client uses to subscribe to a realtime stream of that contact's conversation events. Tokens are short-lived, so call this endpoint again before `expires_at` to get a fresh one. Use the `revoke` link in the response to end every active token for the contact. @@ -22103,6 +22105,8 @@ paths: - Conversations operationId: revokeConversationStreamTokens description: | + Limited availability: this endpoint is enabled per workspace. Contact Intercom to request access. + Revoke every active conversation stream token for a contact. Call this when the contact signs out or you suspect a token has been exposed. Requires the `read_conversations` permission. From e9e2a53564110e2488c377aa274451f42804c7bd Mon Sep 17 00:00:00 2001 From: Keith Stenson <147769+kstenson@users.noreply.github.com> Date: Fri, 6 Nov 2026 14:46:29 +0000 Subject: [PATCH 3/4] Use a placeholder for the example stream token Co-Authored-By: Claude Sonnet 5.5 --- descriptions/0/api.intercom.io.yaml | 4 ++-- descriptions/2.16/api.intercom.io.yaml | 4 ++-- descriptions/2.17/api.intercom.io.yaml | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 48f53d0f..2f2e5cbe 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -22390,7 +22390,7 @@ paths: provider: ably url: main.realtime.ably.net channel: conversation_stream:abc123:6710a1b2c3d4e5f6a7b8c9d0 - token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleGFtcGxlIjoidG9rZW4ifQ.c2lnbmF0dXJl + token: "" links: self: href: https://api.intercom.io/conversations/stream/token @@ -45981,7 +45981,7 @@ components: token: type: string description: The token to connect with. - example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleGFtcGxlIjoidG9rZW4ifQ.c2lnbmF0dXJl + example: "" links: type: object description: The requests you can make with this token. diff --git a/descriptions/2.16/api.intercom.io.yaml b/descriptions/2.16/api.intercom.io.yaml index fdefd683..496c5b85 100644 --- a/descriptions/2.16/api.intercom.io.yaml +++ b/descriptions/2.16/api.intercom.io.yaml @@ -14351,7 +14351,7 @@ paths: provider: ably url: main.realtime.ably.net channel: conversation_stream:abc123:6710a1b2c3d4e5f6a7b8c9d0 - token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleGFtcGxlIjoidG9rZW4ifQ.c2lnbmF0dXJl + token: "" links: self: href: https://api.intercom.io/conversations/stream/token @@ -28116,7 +28116,7 @@ components: token: type: string description: The token to connect with. - example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleGFtcGxlIjoidG9rZW4ifQ.c2lnbmF0dXJl + example: "" links: type: object description: The requests you can make with this token. diff --git a/descriptions/2.17/api.intercom.io.yaml b/descriptions/2.17/api.intercom.io.yaml index 2bc6ab84..a0b06c63 100644 --- a/descriptions/2.17/api.intercom.io.yaml +++ b/descriptions/2.17/api.intercom.io.yaml @@ -22057,7 +22057,7 @@ paths: provider: ably url: main.realtime.ably.net channel: conversation_stream:abc123:6710a1b2c3d4e5f6a7b8c9d0 - token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleGFtcGxlIjoidG9rZW4ifQ.c2lnbmF0dXJl + token: "" links: self: href: https://api.intercom.io/conversations/stream/token @@ -40309,7 +40309,7 @@ components: token: type: string description: The token to connect with. - example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleGFtcGxlIjoidG9rZW4ifQ.c2lnbmF0dXJl + example: "" links: type: object description: The requests you can make with this token. From 4e6d255c7c332c8a640f2b56c43b9fb0fc01726f Mon Sep 17 00:00:00 2001 From: Keith Stenson <147769+kstenson@users.noreply.github.com> Date: Fri, 6 Nov 2026 15:41:35 +0000 Subject: [PATCH 4/4] Describe the conversation stream as an opt-in SSE feature Co-Authored-By: Claude Sonnet 5.5 --- descriptions/0/api.intercom.io.yaml | 4 ++-- descriptions/2.16/api.intercom.io.yaml | 4 ++-- descriptions/2.17/api.intercom.io.yaml | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 2f2e5cbe..ae517a34 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -22359,7 +22359,7 @@ paths: - Conversations operationId: createConversationStreamToken description: | - Limited availability: this endpoint is enabled per workspace. Contact Intercom to request access. + Realtime streaming of conversation events uses Server-Sent Events (SSE). It is an opt-in feature, enabled per workspace. Contact Intercom to turn it on. Issue a token that a contact's client uses to subscribe to a realtime stream of that contact's conversation events. @@ -22438,7 +22438,7 @@ paths: - Conversations operationId: revokeConversationStreamTokens description: | - Limited availability: this endpoint is enabled per workspace. Contact Intercom to request access. + Realtime streaming of conversation events uses Server-Sent Events (SSE). It is an opt-in feature, enabled per workspace. Contact Intercom to turn it on. Revoke every active conversation stream token for a contact. Call this when the contact signs out or you suspect a token has been exposed. diff --git a/descriptions/2.16/api.intercom.io.yaml b/descriptions/2.16/api.intercom.io.yaml index 496c5b85..ff717de2 100644 --- a/descriptions/2.16/api.intercom.io.yaml +++ b/descriptions/2.16/api.intercom.io.yaml @@ -14320,7 +14320,7 @@ paths: - Conversations operationId: createConversationStreamToken description: | - Limited availability: this endpoint is enabled per workspace. Contact Intercom to request access. + Realtime streaming of conversation events uses Server-Sent Events (SSE). It is an opt-in feature, enabled per workspace. Contact Intercom to turn it on. Issue a token that a contact's client uses to subscribe to a realtime stream of that contact's conversation events. @@ -14399,7 +14399,7 @@ paths: - Conversations operationId: revokeConversationStreamTokens description: | - Limited availability: this endpoint is enabled per workspace. Contact Intercom to request access. + Realtime streaming of conversation events uses Server-Sent Events (SSE). It is an opt-in feature, enabled per workspace. Contact Intercom to turn it on. Revoke every active conversation stream token for a contact. Call this when the contact signs out or you suspect a token has been exposed. diff --git a/descriptions/2.17/api.intercom.io.yaml b/descriptions/2.17/api.intercom.io.yaml index a0b06c63..fca9dda5 100644 --- a/descriptions/2.17/api.intercom.io.yaml +++ b/descriptions/2.17/api.intercom.io.yaml @@ -22026,7 +22026,7 @@ paths: - Conversations operationId: createConversationStreamToken description: | - Limited availability: this endpoint is enabled per workspace. Contact Intercom to request access. + Realtime streaming of conversation events uses Server-Sent Events (SSE). It is an opt-in feature, enabled per workspace. Contact Intercom to turn it on. Issue a token that a contact's client uses to subscribe to a realtime stream of that contact's conversation events. @@ -22105,7 +22105,7 @@ paths: - Conversations operationId: revokeConversationStreamTokens description: | - Limited availability: this endpoint is enabled per workspace. Contact Intercom to request access. + Realtime streaming of conversation events uses Server-Sent Events (SSE). It is an opt-in feature, enabled per workspace. Contact Intercom to turn it on. Revoke every active conversation stream token for a contact. Call this when the contact signs out or you suspect a token has been exposed.