Time Cards
time_card_created
- Time Card created modeltime_card_updated
- Time Card updated modeltime_card_archived
- Time Card archived modelweek_submitted
- Week Submitted modelweek_approved
- Week approved modelweek_rejected
- Week rejected model
time_card_created
Payload data sent after Time Card creation.
Properties
Property | Type | Format | Required | Description |
---|---|---|---|---|
type |
string |
true | Payload type (time_card_created ) |
|
actionUserId |
string |
UUID | true | User identifier |
actionExternalUserId |
string |
false | User external identifier | |
projectId |
string |
UUID | true | Project identifier |
organizationId |
string |
UUID | true | Organization identifier |
projectExternalId |
string |
false | Project external identifier | |
data |
TimeCard |
– | true | Created payload data |
Example
{
"type": "time_card_created",
"projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
"organizationId": "b8669d73-be7e-4326-b5ff-2ca9840ecef7",
"projectExternalId": "1",
"actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
"actionExternalUserId": "externalId",
"data": {
"userId": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
"externalUserId": "1",
"date": "2022-10-14T00:00:00"
}
}
time_card_updated
Payload data sent after Time Card update.
Properties
Property | Type | Format | Required | Description |
---|---|---|---|---|
type |
string |
true | Payload type (time_card_updated ) |
|
actionUserId |
string |
UUID | true | User identifier |
actionExternalUserId |
string |
false | User external identifier | |
projectId |
string |
UUID | true | Project identifier |
organizationId |
string |
UUID | true | Organization identifier |
projectExternalId |
string |
false | Project external identifier | |
data |
TimeCard |
– | true | Updated payload data |
Example
{
"type": "time_card_updated",
"projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
"organizationId": "b8669d73-be7e-4326-b5ff-2ca9840ecef7",
"projectExternalId": "1",
"actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
"actionExternalUserId": "externalId",
"data": {
"userId": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
"externalUserId": "1",
"date": "2022-10-14T00:00:00"
}
}
time_card_archived
Payload data sent after Time Card archivization.
Properties
Property | Type | Format | Required | Description |
---|---|---|---|---|
type |
string |
true | Payload type (time_card_archived ) |
|
actionUserId |
string |
UUID | true | User identifier |
actionExternalUserId |
string |
false | User external identifier | |
projectId |
string |
UUID | true | Project identifier |
organizationId |
string |
UUID | true | Organization identifier |
projectExternalId |
string |
false | Project external identifier | |
data |
TimeCard |
– | true | Archived payload data |
Example
{
"type": "time_card_archived",
"projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
"organizationId": "b8669d73-be7e-4326-b5ff-2ca9840ecef7",
"projectExternalId": "1",
"actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
"actionExternalUserId": "externalId",
"data": {
"userId": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
"externalUserId": "1",
"date": "2022-10-14T00:00:00"
}
}
week_submitted
Payload data sent after Week submission.
Properties
Property | Type | Format | Required | Description |
---|---|---|---|---|
type |
string |
true | Payload type (week_submitted ) |
|
actionUserId |
string |
UUID | true | User identifier |
actionExternalUserId |
string |
false | User external identifier | |
projectId |
string |
UUID | true | Project identifier |
organizationId |
string |
UUID | true | Organization identifier |
projectExternalId |
string |
false | Project external identifier | |
data |
Week |
– | true | Submitted payload data |
Example
{
"type": "week_submitted",
"projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
"organizationId": "b8669d73-be7e-4326-b5ff-2ca9840ecef7",
"projectExternalId": "1",
"actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
"actionExternalUserId": "externalId",
"data": {
"userId": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
"externalUserId": "1",
"periodFrom": "2022-10-14T00:00:00"
}
}
week_approved
Payload data sent after Week approval.
Properties
Property | Type | Format | Required | Description |
---|---|---|---|---|
type |
string |
true | Payload type (week_approved ) |
|
actionUserId |
string |
UUID | true | User identifier |
actionExternalUserId |
string |
false | User external identifier | |
projectId |
string |
UUID | true | Project identifier |
organizationId |
string |
UUID | true | Organization identifier |
projectExternalId |
string |
false | Project external identifier | |
data |
Week |
– | true | Approved payload data |
Example
{
"type": "week_approved",
"projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
"organizationId": "b8669d73-be7e-4326-b5ff-2ca9840ecef7",
"projectExternalId": "1",
"actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
"actionExternalUserId": "externalId",
"data": {
"userId": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
"externalUserId": "1",
"periodFrom": "2022-10-14T00:00:00"
}
}
week_rejected
Payload data sent after Week rejection.
Properties
Property | Type | Format | Required | Description |
---|---|---|---|---|
type |
string |
true | Payload type (week_rejected ) |
|
actionUserId |
string |
UUID | true | User identifier |
actionExternalUserId |
string |
false | User external identifier | |
projectId |
string |
UUID | true | Project identifier |
organizationId |
string |
UUID | true | Organization identifier |
projectExternalId |
string |
false | Project external identifier | |
data |
Week |
– | true | Rejected payload data |
Example
{
"type": "week_rejected",
"projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
"organizationId": "b8669d73-be7e-4326-b5ff-2ca9840ecef7",
"projectExternalId": "1",
"actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
"actionExternalUserId": "externalId",
"data": {
"userId": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
"externalUserId": "1",
"periodFrom": "2022-10-14T00:00:00"
}
}