Requirements
- You have read the API overview guide
- You have read the API integration guide
- (optional) You have read the Map IDs guide
- You already have a ticket/task object (from Zendesk, Jira, internal back office, etc.)
Relevant API endpoints
POST /tasks
: create a taskPUT /tasks/:id
: create or update a task (idempotent)PATCH /tasks/:id
: update a taskPOST /tasks/batch
: bulk create tasksPUT /tasks/batch
: bulk create or update tasks (idempotent)PATCH /tasks/batch
: bulk update tasks
Create tasks
Use thePOST /tasks
endpoint to create the task in Fragment.
create.py
Upsert tasks (idempotent)
To avoid double task creation in case of retries and network errors, you can use thePUT /tasks/{uid}
endpoint instead of POST /tasks
.
The PUT endpoint is idempotent and requires you to generate a task ID that is stable across retries (see Map IDs).
For example:
upsert.py
Update tasks
When you update a ticket in your existing system or simply need to update the task in Fragment because of some event, you might need to update the corresponding task in Fragment. Use thePATCH /tasks/{uid}
endpoint to update the task in Fragment.
For example
update.py
Bulk upserts
If you have a high volume of tickets, you might want to create them in bulk. Relevant endpointsPOST /tasks/batch
: create the tasks in Fragment in bulk.PUT /tasks/batch
: create or update the tasks in Fragment in bulk.PATCH /tasks/batch
: update the tasks in Fragment in bulk.