# Objects

## Project

| Name   | Type   | Description         |
| ------ | ------ | ------------------- |
| `uid`  | string | Id of the project   |
| `name` | string | Name of the project |

## Experience

<table><thead><tr><th width="205">Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>uid</code></td><td>string</td><td>Id of the experience</td></tr><tr><td><code>title</code></td><td>number</td><td>Title of the experience</td></tr><tr><td><code>type</code></td><td>one of <code>TOUR</code>, <code>SURVEY</code>, <code>BANNER</code>, <code>HINT</code>, <code>CHECKLIST</code>, <code>POST</code></td><td>Type of the experience</td></tr><tr><td><code>state</code></td><td>one of <code>LIVE</code>, <code>PAUSED</code></td><td>State of the experience</td></tr><tr><td><code>isDraft</code></td><td>boolean</td><td><p>Tells if an experience is still</p><p>draft mode. Once the experience is published, this property is set to <code>false</code>.</p></td></tr><tr><td><code>createdAt</code></td><td>Date</td><td>Creation date of the experience</td></tr><tr><td><code>publishedAt</code></td><td>Date</td><td>Publication date of the experience</td></tr><tr><td><code>expiresAt</code></td><td>Date</td><td>Date at which the experience will expires</td></tr><tr><td><code>triggerType</code></td><td>one of <code>DEFAULT</code>, <code>EVENT</code>, <code>MANUAL</code>, <code>LEAVE_PAGE</code>, <code>URL</code>, <code>NONE</code></td><td>How an experience is supposed to be triggered. <code>DEFAULT</code> correspond on the trigger on page opening.</td></tr><tr><td><code>recurrencyType</code></td><td>one of <code>SINGLE_TIME</code>, <code>EVERY_TIME</code>, <code>DAY_BASED</code></td><td>The recurrence of an experience</td></tr><tr><td><code>recurrencyValue</code></td><td>number</td><td>If <code>recurrencyType</code> is equal to <code>DAY_BASED</code>, this property is the number of days.</td></tr><tr><td><code>tags</code></td><td>Array&#x3C;{ uid: string, name: string }></td><td>List of tags associated to the experience</td></tr></tbody></table>

## User

Represents a member of your workspace team

| Name        | Type   | Description            |
| ----------- | ------ | ---------------------- |
| `uid`       | string | Id of the user         |
| `email`     | string | Email of the user      |
| `firstName` | string | First name of the user |
| `lastName`  | string | Last name of the user  |

## Jimer

Represents a user of your app

| Name             | Type   | Description                                                                                                                                       |
| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `uid`            | string | Id of the jimer                                                                                                                                   |
| `identifyToken`  | string | Identify token of the jimer. This field is set using our [identify SDK method](/docs/for-developers/for-developers/sdk-guides/identify-users.md). |
| `username`       | string | Username of the jimer                                                                                                                             |
| `email`          | string | Email of the jimer                                                                                                                                |
| `lastActivityAt` | Date   | Last time the jimer was active                                                                                                                    |
| `createdAt`      | Date   | Creation date of the jimer                                                                                                                        |

## Step

Represent a step of an experience

| Name         | Type                                                                                                                                                                                     | Description                             |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| `uid`        | string                                                                                                                                                                                   | Id of the step                          |
| `name`       | string                                                                                                                                                                                   | Name of the step                        |
| `type`       | one of `OPINION_SCALE`, `MULTIPLE_CHOICE_MULTI_SELECT`, `MULTIPLE_CHOICE_SINGLE_SELECT`, `TEXT_LONG`, `SLIDER`, `NPS`, `TEXT_BLOCK`, `CONCEPT_TEST`, `INTERVIEW`, `SUCCESS`, `CHECKLIST` | Type of the step                        |
| `indexOrder` | number                                                                                                                                                                                   | Index order of the step (starts at `0`) |

## Survey

Represent a survey of a user. Each user have one survey per survey experiences. A survey holds the user answers. It can be used to determine if several answers belong to the same survey completion.

| Name        | Type   | Description                 |
| ----------- | ------ | --------------------------- |
| `uid`       | string | Id of the survey            |
| `createdAt` | Date   | Creation date of the survey |

## Answer

Represent an answer to a step of a survey experience

| Name    | Type   | Description                                                            |
| ------- | ------ | ---------------------------------------------------------------------- |
| `uid`   | string | Id of the answer                                                       |
| `value` | string | Value of the answer. Can vary based on the type of Step been answered. |

## Task

Represent a task of a checklist

| Name   | Type   | Description      |
| ------ | ------ | ---------------- |
| `uid`  | string | Id of the task   |
| `name` | string | Name of the task |

## Comment

Represent a comment of changelog post

| Name      | Type   | Description            |
| --------- | ------ | ---------------------- |
| `uid`     | string | Id of the comment      |
| `message` | string | Message of the comment |

## CTA

Represent a CTA of tour or changelog post

| Name   | Type                                  | Description     |
| ------ | ------------------------------------- | --------------- |
| `uid`  | string                                | Id of the CTA   |
| `text` | string                                | Text of the CTA |
| `type` | one of `PRIMARY_CTA`, `SECONDARY_CTA` | Type of the CTA |

## Request

| Name      | Type   | Description            |
| --------- | ------ | ---------------------- |
| `uid`     | string | Id of the request      |
| `title`   | string | Title of the request   |
| `content` | string | Content of the request |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.usejimo.com/docs/for-developers/for-developers/webhooks/objects.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.