Wrangle API Documentation

Get Inboxes

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

slackUserIdstringRequired

slackWorkspaceIdstringRequired

Responses

200

Get Inboxes Response

application/json

successstring · enumRequiredPossible values:

default

unexpected error

application/json

get/inboxes

HTTPcURLJavaScriptPython

GET /api/v1/inboxes?slackUserId=text&slackWorkspaceId=text HTTP/1.1
Host: slack.wrangle.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": "true",
  "inboxes": [
    {
      "createdAt": "text",
      "creatorId": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "formFields": {
        "fieldId": "text",
        "fieldLabel": "text",
        "isRequired": true,
        "fieldType": "Date Picker",
        "fieldOptions": [
          "text"
        ]
      },
      "name": "text",
      "description": "text",
      "defaultUserRole": "REQUESTER",
      "status": "ACTIVE",
      "tags": [
        "text"
      ],
      "userRoles": [
        {
          "role": "NO_ACCESS",
          "userId": "text"
        }
      ],
      "updatedAt": "text"
    }
  ]
}

Get Inbox

get

Get an inbox by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

inboxIdstringRequired

Query parameters

slackUserIdstringRequired

slackWorkspaceIdstringRequired

Responses

200

Get Inbox

application/json

successstring · enumRequiredPossible values:

default

unexpected error

application/json

get/inboxes/{inboxId}

HTTPcURLJavaScriptPython

GET /api/v1/inboxes/{inboxId}?slackUserId=text&slackWorkspaceId=text HTTP/1.1
Host: slack.wrangle.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": "true",
  "inbox": {
    "createdAt": "text",
    "creatorId": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "formFields": {
      "fieldId": "text",
      "fieldLabel": "text",
      "isRequired": true,
      "fieldType": "Date Picker",
      "fieldOptions": [
        "text"
      ]
    },
    "name": "text",
    "description": "text",
    "defaultUserRole": "REQUESTER",
    "status": "ACTIVE",
    "tags": [
      "text"
    ],
    "userRoles": [
      {
        "role": "NO_ACCESS",
        "userId": "text"
      }
    ],
    "updatedAt": "text"
  }
}

Update Inbox

put

Update an inbox.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

inboxIdstringRequired

Query parameters

slackUserIdstringRequired

slackWorkspaceIdstringRequired

Body

application/json

Update an inbox.

Responses

200

Update Inbox

application/json

successstring · enumRequiredPossible values:

default

unexpected error

application/json

put/inboxes/{inboxId}

HTTPcURLJavaScriptPython

PUT /api/v1/inboxes/{inboxId}?slackUserId=text&slackWorkspaceId=text HTTP/1.1
Host: slack.wrangle.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "userRoles": {
    "NO_ACCESS": [
      "text"
    ],
    "REQUESTER": [
      "text"
    ],
    "OBSERVER": [
      "text"
    ]
  }
}

{
  "success": "true",
  "inbox": {
    "createdAt": "text",
    "creatorId": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "formFields": {
      "fieldId": "text",
      "fieldLabel": "text",
      "isRequired": true,
      "fieldType": "Date Picker",
      "fieldOptions": [
        "text"
      ]
    },
    "name": "text",
    "description": "text",
    "defaultUserRole": "REQUESTER",
    "status": "ACTIVE",
    "tags": [
      "text"
    ],
    "userRoles": [
      {
        "role": "NO_ACCESS",
        "userId": "text"
      }
    ],
    "updatedAt": "text"
  }
}

Get Tickets

get

Get tickets for an inbox. Query parameters are documented as an object in the Request_GetTickets schema.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

inboxIdstringRequired

Query parameters

slackUserIdstringRequired

slackWorkspaceIdstringRequired

pageinteger · min: 1Optional

Page number for pagination (1-based). Defaults to 1.

Default: 1

pageSizeinteger · min: 1 · max: 200Optional

Number of tickets per page. Maximum 200. Defaults to 200.

Default: 200

Responses

200

Get Tickets

application/json

successstring · enumRequiredPossible values:

default

unexpected error

application/json

get/inboxes/{inboxId}/tickets

HTTPcURLJavaScriptPython

GET /api/v1/inboxes/{inboxId}/tickets?slackUserId=text&slackWorkspaceId=text HTTP/1.1
Host: slack.wrangle.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": "true",
  "tickets": [
    {
      "assigneeId": "text",
      "createdAt": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "requesterId": "text",
      "status": "CLOSED",
      "updatedAt": "text"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "totalCount": 1,
    "totalPages": 1
  }
}

Create Ticket

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

slackUserIdstringRequired

slackWorkspaceIdstringRequired

Body

application/json

descriptionstringOptional

inboxIdstringRequired

namestringRequired

The name of the ticket.

requesterIdstringRequired

The Slack user ID of the ticket requester. Can be different than the creatorId, for example when an agent creates a ticket on behalf of another user.

prioritystring · enumOptionalPossible values:

tagsstring[]Optional

Responses

200

Create Ticket Response

application/json

successstring · enumRequiredPossible values:

default

unexpected error

application/json

post/tickets

HTTPcURLJavaScriptPython

POST /api/v1/tickets?slackUserId=text&slackWorkspaceId=text HTTP/1.1
Host: slack.wrangle.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 166

{
  "description": "text",
  "formFieldValues": [
    {
      "fieldId": "text",
      "value": "text"
    }
  ],
  "inboxId": "text",
  "name": "text",
  "requesterId": "text",
  "priority": "CRITICAL",
  "tags": [
    "text"
  ]
}

{
  "success": "true",
  "ticket": {
    "description": "text",
    "formFieldValues": [
      {
        "fieldId": "text",
        "value": "text"
      }
    ],
    "inboxId": "text",
    "name": "text",
    "requesterId": "text",
    "priority": "CRITICAL",
    "tags": [
      "text"
    ],
    "assigneeId": "text",
    "createdAt": "text",
    "creatorId": "text",
    "csatScore": "1",
    "csatReason": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "slackMessageChannel": "text",
    "slackMessageTs": "text",
    "slackOriginalMessage": {
      "channel": "text",
      "ts": "text",
      "parentMessageTs": "text",
      "permalinkUrl": "text"
    },
    "slackParentMessageTs": "text",
    "slackPermalinkUrl": "text",
    "status": "CLOSED",
    "workspaceId": "text",
    "workspaceTicketNumber": 1
  }
}

Get Ticket

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ticketIdstringRequired

Query parameters

slackUserIdstringRequired

slackWorkspaceIdstringRequired

includeRepliesbooleanOptional

When 'true', include the ticket's replies in the response.

Responses

200

Get Ticket Response

application/json

descriptionstringOptional

inboxIdstringRequired

namestringRequired

The name of the ticket.

requesterIdstringRequired

prioritystring · enumOptionalPossible values:

tagsstring[]Optional

assigneeIdstring · nullableOptional

The Slack user ID of the ticket assignee. They must be an agent for this ticket's inbox.

createdAtstringOptional

creatorIdstringOptional

csatScorestring · enumOptional

The customer satisfaction score for the ticket if one exists.

Possible values:

csatReasonstringOptional

The reason for the customer satisfaction score if one exists.

idstring · uuidRequired

slackMessageChannelstringOptional

slackMessageTsstringOptional

slackParentMessageTsstringOptional

slackPermalinkUrlstringOptional

Link to the ticket in Slack.

statusstring · enumRequiredPossible values:

workspaceIdstringOptional

workspaceTicketNumbernumberOptional

default

unexpected error

application/json

get/tickets/{ticketId}

HTTPcURLJavaScriptPython

GET /api/v1/tickets/{ticketId}?slackUserId=text&slackWorkspaceId=text HTTP/1.1
Host: slack.wrangle.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "description": "text",
  "formFieldValues": [
    {
      "fieldId": "text",
      "value": "text"
    }
  ],
  "inboxId": "text",
  "name": "text",
  "requesterId": "text",
  "priority": "CRITICAL",
  "tags": [
    "text"
  ],
  "assigneeId": "text",
  "createdAt": "text",
  "creatorId": "text",
  "csatScore": "1",
  "csatReason": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "slackMessageChannel": "text",
  "slackMessageTs": "text",
  "slackOriginalMessage": {
    "channel": "text",
    "ts": "text",
    "parentMessageTs": "text",
    "permalinkUrl": "text"
  },
  "slackParentMessageTs": "text",
  "slackPermalinkUrl": "text",
  "status": "CLOSED",
  "workspaceId": "text",
  "workspaceTicketNumber": 1,
  "replies": [
    {
      "authorSlackUserId": "text",
      "authorSlackWorkspaceId": "text",
      "channelId": "text",
      "createdAt": "text",
      "isPrivate": true,
      "markdownText": "text",
      "slackParentTs": "text",
      "slackTs": "text",
      "updatedAt": "text"
    }
  ]
}

Update Ticket

put

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ticketIdstringRequired

Query parameters

slackUserIdstringRequired

slackWorkspaceIdstringRequired

Body

application/json

assigneeIdstring · nullableOptional

The Slack user ID of the ticket assignee. They must be an agent for this ticket's inbox. To unassign a ticket, set this to null. If a ticket is assigned, it's status will automatically be set to IN_PROGRESS. If a ticket is unassigned, it's status will automatically be set to NEW.

csatScorestring · enumOptional

The customer satisfaction score for the ticket. Must be a value between 1 and 5. Satisfaction surveys must be enabled for the ticket's inbox.

Possible values:

descriptionstringOptional

inboxIdstringOptional

Move this ticket to a new inbox. Will clear the assignee, status, tags, and other inbox-specific settings.

namestringOptional

prioritystring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

tagsstring[]Optional

Responses

200

Update Ticket Response

application/json

successstring · enumRequiredPossible values:

default

unexpected error

application/json

put/tickets/{ticketId}

HTTPcURLJavaScriptPython

PUT /api/v1/tickets/{ticketId}?slackUserId=text&slackWorkspaceId=text HTTP/1.1
Host: slack.wrangle.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "assigneeId": "text",
  "csatScore": "1",
  "description": "text",
  "followers": [
    {
      "userId": "text"
    }
  ],
  "formFieldValues": [
    {
      "fieldId": "text",
      "value": "text"
    }
  ],
  "inboxId": "text",
  "name": "text",
  "priority": "CRITICAL",
  "status": "CLOSED",
  "tags": [
    "text"
  ]
}

{
  "success": "true",
  "ticket": {
    "description": "text",
    "formFieldValues": [
      {
        "fieldId": "text",
        "value": "text"
      }
    ],
    "inboxId": "text",
    "name": "text",
    "requesterId": "text",
    "priority": "CRITICAL",
    "tags": [
      "text"
    ],
    "assigneeId": "text",
    "createdAt": "text",
    "creatorId": "text",
    "csatScore": "1",
    "csatReason": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "slackMessageChannel": "text",
    "slackMessageTs": "text",
    "slackOriginalMessage": {
      "channel": "text",
      "ts": "text",
      "parentMessageTs": "text",
      "permalinkUrl": "text"
    },
    "slackParentMessageTs": "text",
    "slackPermalinkUrl": "text",
    "status": "CLOSED",
    "workspaceId": "text",
    "workspaceTicketNumber": 1
  }
}

Delete Ticket

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ticketIdstringRequired

Query parameters

slackUserIdstringRequired

slackWorkspaceIdstringRequired

Responses

200

Delete Ticket Response

application/json

successstring · enumRequiredPossible values:

default

unexpected error

application/json

delete/tickets/{ticketId}

HTTPcURLJavaScriptPython

DELETE /api/v1/tickets/{ticketId}?slackUserId=text&slackWorkspaceId=text HTTP/1.1
Host: slack.wrangle.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": "true"
}

Get Workflows

get

Get active workflows for a workspace.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

slackUserIdstringRequired

slackWorkspaceIdstringRequired

Responses

200

Get Workflows Response

application/json

successstring · enumRequiredPossible values:

default

unexpected error

application/json

get/workflows

HTTPcURLJavaScriptPython

GET /api/v1/workflows?slackUserId=text&slackWorkspaceId=text HTTP/1.1
Host: slack.wrangle.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": "true",
  "workflows": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ]
}

Get Workflow

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workflowIdstringRequired

Query parameters

slackUserIdstringRequired

slackWorkspaceIdstringRequired

Responses

200

Get Workflow Response

application/json

successstring · enumRequiredPossible values:

default

unexpected error

application/json

get/workflows/{workflowId}

HTTPcURLJavaScriptPython

GET /api/v1/workflows/{workflowId}?slackUserId=text&slackWorkspaceId=text HTTP/1.1
Host: slack.wrangle.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": "true",
  "workflow": {
    "id": "text",
    "name": "text",
    "intakeFormFields": {
      "fieldId": "text",
      "fieldLabel": "text",
      "isRequired": true,
      "fieldType": "Date Picker",
      "fieldOptions": [
        "text"
      ]
    }
  }
}

Start Workflow

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workflowIdstringRequired

Query parameters

slackUserIdstringRequired

slackWorkspaceIdstringRequired

Body

application/json

requesterIdstringRequired

The Slack user ID of the user starting this workflow instance.

Responses

200

Start a Workflow

application/json

successstring · enumRequiredPossible values:

workflowInstanceIdstring · uuidRequired

default

unexpected error

application/json

post/workflows/{workflowId}/instances

HTTPcURLJavaScriptPython

POST /api/v1/workflows/{workflowId}/instances?slackUserId=text&slackWorkspaceId=text HTTP/1.1
Host: slack.wrangle.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "requesterId": "text",
  "formFieldValues": [
    {
      "fieldId": "text",
      "value": "text"
    }
  ]
}

{
  "success": "true",
  "workflowInstanceId": "123e4567-e89b-12d3-a456-426614174000"
}

Create Reply

post

Create a reply on a ticket. Anyone who can view the ticket may reply as themselves; attributing the reply to another user (via slackUserId or email) requires admin access, and posting a private reply requires agent or admin access.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ticketIdstringRequired

Query parameters

slackUserIdstringRequired

slackWorkspaceIdstringRequired

Body

application/json

markdownTextstringRequired

The reply body in Slack formatted markdown. Required.

authorSlackUserIdstringOptional

The Slack user ID to attribute the reply to. You must provide either an authorSlackUserId or an authorEmail, not both.

authorEmailstring · emailOptional

The email address of the user to attribute the reply to. This user must exist in your Slack workspace. You must provide either an authorSlackUserId or an authorEmail, not both.

isPrivatebooleanOptional

Post the reply as private (visible only to agents/observers). Requires agent or admin access.

Responses

200

Create Reply Response

application/json

successbooleanRequired

default

unexpected error

application/json

post/tickets/{ticketId}/reply

HTTPcURLJavaScriptPython

POST /api/v1/tickets/{ticketId}/reply?slackUserId=text&slackWorkspaceId=text HTTP/1.1
Host: slack.wrangle.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "markdownText": "text",
  "authorSlackUserId": "text",
  "authorEmail": "[e-mail]",
  "isPrivate": true
}

{
  "success": true,
  "reply": {
    "authorSlackUserId": "text",
    "authorSlackWorkspaceId": "text",
    "channelId": "text",
    "createdAt": "text",
    "isPrivate": true,
    "markdownText": "text",
    "slackParentTs": "text",
    "slackTs": "text",
    "updatedAt": "text"
  }
}