Common types – Baack docs
Common types
Types shared by several representations, such as pagination, and types used outside a single resource.
Error
General API error object representation
Fields
| Field | Type | Description |
|---|---|---|
| apiCode | string | One of: |
| detail | string | |
| httpCode | integer |
Pagination
Fields
| Field | Type | Description |
|---|---|---|
| isMorePages | boolean | |
| after | string | |
| nextUrl | string (uri) |
Used by: Boolean item history, Date / Time item history, Double Item History, Identity Notification Inbox, Image item history, Json item history, Lat / Long item history, Link Item History, Long item history, Markdown item history, Message Thread, Money item history, Search, Template item history, Text Item History
Webhook Event
The webhook event representation is used for webhook message delivery acting like an envelope for the event.
Fields
| Field | Type | Description |
|---|---|---|
| trigger | Webhook Trigger | Ignored on update. |
| subscription | Webhook Subscription | Ignored on update. |
| v1 | Webhook Event Target | Ignored on update. |
Webhook Event Target
Representation of the concept that a webhook trigger event relates to
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | |
| url | string (uri) |
Used by: Webhook Event
Workflow Stage
A single stage in a workflow
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | |
| name | string | Required on create. Up to 255 characters. |
| order | integer (int32) |