Post Actions

POST

https://app.hindsiteind.com/api/v2/actions

POST

/api/v2/actions

curl -X POST https://app.hindsiteind.com/api/v2/actions \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "title": "string"
}'

201Created

{
  "id": "string",
  "title": "string",
  "description": "string",
  "status": "todo",
  "priority": "no_priority",
  "actionable_type": "WorkOrder",
  "actionable_id": "string",
  "assigned_to_id": "string",
  "user_id": "string",
  "organisation_id": "string",
  "due_date": 1,
  "scheduled_at": "2024-01-15T09:30:00Z",
  "completed_at": 1,
  "notes": [
    {
      "id": "string",
      "content": "string",
      "plain_text_content": "string",
      "user": {
        "id": "string",
        "email": "string",
        "name": "string",
        "is_admin": true,
        "location_manager": true,
        "last_active_at": 1,
        "archived": true,
        "organisation_id": "string",
        "created_at": 1,
        "updated_at": 1
      },
      "noteable_type": "string",
      "noteable_id": "string",
      "attachments": [
        {
          "blob_url": "string",
          "signed_id": "string",
          "filename": "string",
          "byte_size": 1,
          "content_type": "string",
          "preview_url": "string",
          "key": "string",
          "direct_upload": {
            "url": "string",
            "headers": {}
          }
        }
      ],
      "created_at": 1,
      "updated_at": 1
    }
  ],
  "user": {
    "id": "string",
    "email": "string",
    "name": "string",
    "is_admin": true,
    "location_manager": true,
    "last_active_at": 1,
    "archived": true,
    "organisation_id": "string",
    "created_at": 1,
    "updated_at": 1
  },
  "contents": [
    {
      "id": 1,
      "original": "string",
      "versions": [
        "string"
      ],
      "thumbnails": [
        "string"
      ],
      "title": "string",
      "created_at": 1,
      "updated_at": 1
    }
  ],
  "assigned_to": {
    "id": "string",
    "name": "string"
  },
  "created_at": 1,
  "updated_at": 1,
  "actionable": {}
}

Creates an action. An omitted status defaults to todo and an omitted priority to no_priority.

Authentication

AuthorizationBearer

OAuth 2.0 Client Credentials Flow. To obtain an access token:

Request API credentials from HINDSITE support to receive your client_id and client_secret
Make a POST request to obtain an access token:

POST https://app.hindsiteind.com/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET

The response will contain your access token:

{
  "access_token": "your_access_token_here",
  "token_type": "Bearer",
  "expires_in": 7200,
  "created_at": 1234567890
}

Include the token in subsequent API requests:

Authorization: Bearer your_access_token_here

Request

This endpoint expects an object.

titlestringRequired

descriptionstringOptional

statusenumOptionalDefaults to todo

Allowed values:

priorityenumOptionalDefaults to no_priority

Allowed values:

actionable_typeenumOptional

actionable_idstringOptional

assigned_to_idstringOptional

due_datedatetimeOptional

contentslist of objectsOptional

Response

created Action

idstringOptional

ULID

titlestringOptional

descriptionstringOptional

statusenumOptional

Allowed values:

priorityenumOptional

Allowed values:

actionable_typeenumOptional

actionable_idstringOptional

ULID

assigned_to_idstringOptional

ULID

user_idstringOptional

ULID

organisation_idstringOptional

ULID

due_datelong or nullOptional

Unix timestamp (seconds since epoch); null when the action has no due date

scheduled_atdatetime or nullOptional

The due date as ISO 8601 in the organisation’s time zone; null when the action has no due date

completed_atlong or nullOptional

Unix timestamp (seconds since epoch); null until the action is completed

noteslist of objectsOptional

userobjectOptional

contentslist of objectsOptional

assigned_toobjectOptional

created_atlongOptional

Unix timestamp (seconds since epoch)

updated_atlongOptional

Unix timestamp (seconds since epoch)

actionableobjectOptional

The FormStep the action belongs to; present when actionable_type is FormStep or FormInput::Option