Skip to content

Commit 9e05a10

Browse files
committed
Include jobs api spec in docs
1 parent 5de6196 commit 9e05a10

File tree

1 file changed

+103
-1
lines changed

1 file changed

+103
-1
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 103 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8616,6 +8616,68 @@ paths:
86168616
responses:
86178617
'200':
86188618
description: successful
8619+
"/jobs/status/{id}":
8620+
get:
8621+
summary: Retrieve job status
8622+
parameters:
8623+
- name: Intercom-Version
8624+
in: header
8625+
schema:
8626+
"$ref": "#/components/schemas/intercom_version"
8627+
- name: id
8628+
in: path
8629+
required: true
8630+
description: The unique identifier for the job which is given by Intercom
8631+
schema:
8632+
type: string
8633+
tags:
8634+
- Jobs
8635+
operationId: jobsStatus
8636+
description: Retrieve the status of job execution.
8637+
responses:
8638+
'200':
8639+
description: Job status retrieved
8640+
content:
8641+
application/json:
8642+
examples:
8643+
job status retrieved:
8644+
value:
8645+
type: job
8646+
id: '2'
8647+
status: success
8648+
resource_type: ticket
8649+
resource_id: '20'
8650+
resource_url: 'https://api.intercom.io/tickets/20'
8651+
schema:
8652+
"$ref": "#/components/schemas/jobs"
8653+
'404':
8654+
description: Job not found
8655+
content:
8656+
application/json:
8657+
examples:
8658+
Job not found:
8659+
value:
8660+
type: error.list
8661+
request_id: 123e4567-e89b-12d3-a456-426614174000
8662+
errors:
8663+
- code: job_not_found
8664+
message: Job Not Found
8665+
schema:
8666+
"$ref": "#/components/schemas/error"
8667+
'401':
8668+
description: Unauthorized
8669+
content:
8670+
application/json:
8671+
examples:
8672+
Unauthorized:
8673+
value:
8674+
type: error.list
8675+
request_id: 2c8a20ee-ed09-42c0-a31d-a1b4f5d2742d
8676+
errors:
8677+
- code: unauthorized
8678+
message: Access Token Invalid
8679+
schema:
8680+
"$ref": "#/components/schemas/error"
86198681
"/messages":
86208682
post:
86218683
summary: Create a message
@@ -11503,7 +11565,7 @@ paths:
1150311565
ticket_attributes:
1150411566
_default_title_: example
1150511567
_default_description_: there is a problem
11506-
"/tickets/enqueue":
11568+
"/tickets/enqueue":
1150711569
post:
1150811570
summary: Enqueue create ticket
1150911571
description: Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job.
@@ -17622,6 +17684,44 @@ components:
1762217684
description: An array of Help Center objects
1762317685
items:
1762417686
"$ref": "#/components/schemas/help_center"
17687+
jobs:
17688+
title: Jobs
17689+
type: object
17690+
x-tags:
17691+
- Jobs
17692+
description: Jobs are tasks that are processed asynchronously by the Intercom system after being enqueued via the API. This allows for efficient handling of operations that may take time to complete, such as data imports or exports. You can check the status of your jobs to monitor their progress and ensure they are completed successfully.
17693+
properties:
17694+
type:
17695+
type: string
17696+
description: The type of the object
17697+
enum:
17698+
- job
17699+
example: job
17700+
id:
17701+
type: string
17702+
description: The id of the job that's currently being processed or has completed.
17703+
example: success
17704+
status:
17705+
type: string
17706+
description: The status of the job execution.
17707+
enum:
17708+
- pending
17709+
- success
17710+
- failed
17711+
resource_type:
17712+
type: string
17713+
description: The type of resource created during job execution.
17714+
example: ticket
17715+
resource_id:
17716+
type: string
17717+
description: The id of the resource created during job execution (e.g. ticket id)
17718+
example: 20
17719+
resource_url:
17720+
type: string
17721+
description: The url of the resource created during job exeuction. Use this url to fetch the resource.
17722+
example: http://api.intercom.io/tickets/20
17723+
required:
17724+
- id
1762517725
intercom_version:
1762617726
description: Intercom API version.</br>By default, it's equal to the version
1762717727
set in the app package.
@@ -20168,6 +20268,8 @@ tags:
2016820268
description: Everything about your Data Exports
2016920269
- name: Help Center
2017020270
description: Everything about your Help Center
20271+
- name: Jobs
20272+
description: Everything about jobs
2017120273
- name: Messages
2017220274
description: Everything about your messages
2017320275
- name: News

0 commit comments

Comments
 (0)