Get

Description

Retrieve a specific case button.

Request

HTTP Method: GET

Path Parameter Description
case_id ID of the case.
id ID of the case button.
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/cases/<<case_id>>/buttons/<<id>> \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a case button.

Field description

Parameter Description
id The case button ID.
url The URL of the case button.
label The label of the case button.
button_type The case button type (webhook or page).
story_name Will be populated if the URL matches that of a page or webhook in an existing story.
story_emoji The associated story's emoji icon.
created_at ISO 8601 Timestamp representing creation date and time of the case button.
updated_at ISO 8601 Timestamp representing last updated date and time of case button.

Sample response

{
  "id": 1,
  "url": "https://tenant.tines.com/webhook/abc/",
  "label": "Claim case",
  "story_name": "Case Management",
  "story_emoji": ":fire:",
  "button_type": "webhook",
  "created_at": "2023-10-31T15:42:00Z",
  "updated_at": "2023-10-31T16:42:00Z"
}
Was this helpful?