WiseTime Connect API (1.2.3)
Download OpenAPI specification:Download
Use the WiseTime Connect API to build connectors to your application.
ConnectApiKeyAuth
See the Authentication documentation page for more details.
| Security Scheme Type | API Key |
|---|---|
| Header parameter name: | x-api-key |
Retrieve information about the team
Authorizations:
Responses
Successfully found the team info.
A valid API key is required to access this resource.
An unexpected error occured.
Response samples
- 200
{- "teamName": "string"
}Create a new tag, or update the tag if it already exists
Authorizations:
Request Body schema: application/json
| name | string Tag name to create. If a tag by this name already exists, the tag will be updated. |
| description | string Displayed in the GUI and search functions. An empty (or null) description will be ignored, the description will remain with the previous value instead of replacing it. |
| excludeTagNameKeyword | boolean The default behaviour when creating a tag is for the tagName to be added as a keyword for the tag. If excludeTagNameKeyword is set to true, the tagName will not be added as a keyword, unless it is explicitly defined in the additionalKeywords list of the request. |
| path | string Path at which to create the tag. The path must start with a / and end with a / For example /myteam/inprotech/ Use / to create tag in root. |
| additionalKeywords | Array of strings A tag is applied to a time row if one of its keywords matches text in the time row activity description. Keywords provided via this property will be added to the list of existing keywords for the tag. Existing keywords won't be removed. |
| url | string If a URL is provided, the tag will be a clickable link in the WiseTime console. Clicking on the tag will open the URL. |
Responses
Tag successfully created or updated.
Invalid request. Tag name is missing or path is invalid.
A valid API key is required to access this resource.
Number of tags plan limit exceeded.
An unexpected error occured.
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "excludeTagNameKeyword": true,
- "path": "string",
- "additionalKeywords": [
- "string"
], - "url": "string"
}Response samples
- 200
{ }Create new tags, or update existing in batch (up to 2000 items at once)
Authorizations:
Request Body schema: application/json
| tags | Array of objects (UpsertTagRequest) |
Responses
Tag successfully created or updated.
Invalid request. Tag name is missing or path is invalid.
A valid API key is required to access this resource.
Number of tags plan limit exceeded.
An unexpected error occured.
Request samples
- Payload
{- "tags": [
- {
- "name": "string",
- "description": "string",
- "excludeTagNameKeyword": true,
- "path": "string",
- "additionalKeywords": [
- "string"
], - "url": "string"
}
]
}Response samples
- 400
{- "errors": [
- {
- "index": 0,
- "errorDescrition": "string"
}
]
}Delete an existing tag
Authorizations:
Request Body schema: application/json
| name | string Tag name to delete. |
Responses
Tag successfully updated.
Invalid request. Tag name is required.
A valid API key is required to access this resource.
Tag not found.
An unexpected error occured.
Request samples
- Payload
{- "name": "string"
}Response samples
- 200
{ }Add one or more keywords to an existing tag
Authorizations:
Request Body schema: application/json
| tagName | string The tag to which to add the keywords. |
| additionalKeywords | Array of strings One or more new keywords for the tag. Keywords provided via this property will be added to the list of existing keywords for the tag. Existing keywords won't be removed. |
Responses
Keyword(s) successfully added.
Invalid request. Tag name and additional keywords are required.
A valid API key is required to access this resource.
Tag not found.
An unexpected error occured.
Request samples
- Payload
{- "tagName": "string",
- "additionalKeywords": [
- "string"
]
}Response samples
- 200
{ }Delete an existing keyword from a tag
Authorizations:
Request Body schema: application/json
| tagName | string The tag from which to delete the keywords. |
| keyword | string The keyword to delete. |
Responses
Tag successfully deleted.
Invalid request. Tag name and keyword are required.
A valid API key is required to access this resource.
Tag or keyword not found.
An unexpected error occured.
Request samples
- Payload
{- "tagName": "string",
- "keyword": "string"
}Response samples
- 200
{ }Returns posted time with pending status.
Use this endpoint to fetch posted time for processing. This is a long polling call (an alternative to using the webhook mechanism). The connection will be held open for a maximum of 60 seconds or until there is a new posted time event. When calling this method without first calling the /postedtime/registerfetchclient endpoint, recording posted time for fetching will implicitly be turned on.
Authorizations:
query Parameters
| limit | integer Maximum amount of posted time entries to retrieve. If not set, the API will return up to a maximum of 25 entries for each request. |
Responses
List of posted time events.
Invalid request. Limit cannot be smaller than 1.
A valid API key is required to access this resource.
This team has a registered posted time webhook. Switching to use fetch client is required.
An unexpected error occured.
Response samples
- 200
[- {
- "callerKey": "string",
- "groupId": "string",
- "description": "string",
- "totalDurationSecs": 0,
- "groupName": "string",
- "narrativeType": "NARRATIVE_AND_TIME_ROW_ACTIVITY_DESCRIPTIONS",
- "status": "PENDING",
- "submissionTime": null,
- "tags": [
- {
- "name": "string",
- "path": "string",
- "description": "string"
}
], - "timeRows": [
- {
- "activity": "string",
- "description": "string",
- "activityHour": 0,
- "firstObservedInHour": 0,
- "durationSecs": 0,
- "submittedDate": null,
- "modifier": "string",
- "activityTypeCode": "string",
- "source": "WT_DESKTOP"
}
], - "user": {
- "name": "string",
- "email": "string",
- "externalId": "string",
- "businessRole": "string",
- "experienceWeightingPercent": 0
}, - "originatingUser": {
- "name": "string",
- "email": "string",
- "externalId": "string",
- "businessRole": "string",
- "experienceWeightingPercent": 0
}, - "durationSplitStrategy": "DIVIDE_BETWEEN_TAGS"
}
]Register the intent to fetch time from the /postedtime endpoint.
WiseTime will start recording posted time events that can be fetched via the /postedtime endpoint.
Authorizations:
Request Body schema: application/json
Responses
Fetch client successfully registered.
Invalid request. Callback URL is required.
A valid API key is required to access this resource.
This team already has a registered fetch client or webhook.
An unexpected error occured.
Request samples
- Payload
{ }Response samples
- 200
{ }Delete existing fetch client, unsubscribing your application from posted time fetching.
WiseTime will stop recording posted time events for fetch when users post time to your team.
Authorizations:
Request Body schema: application/json
Responses
Fetch client successfully unregistered.
A valid API key is required to access this resource.
Fetch client not found.
This team has a registered posted time webhook. Switching to use fetch client is required.
An unexpected error occured.
Request samples
- Payload
{ }Response samples
- 200
{ }Updates the status of a received time group. Providing its success or failure to be processed.
This is intended for use with the fetch mechanism only. Not to be used with webhooks. If this endpoint isn't called for a time group within a certain amount of time after fetching it the time group will be made available again for fetching.
Authorizations:
Request Body schema: application/json
| timeGroupId | string ID of the time group to be updated. |
| status | string Enum: "SUCCESS" "FAILURE" "RETRIABLE_FAILURE" This field describes the status of the posted time group. On SUCCESS the time group will be marked as successfully posted. On FAILURE the time group will be marked as failed and the attached message will displayed to the user. On RETRIABLE_FAILURE the time group will be marked as temporary failed and scheduled for retry. The attached message might be displayed to the user. |
| message | string Reason for the failure, will be displayed to the user. |
Responses
Status of the time group was updated successfully.
Invalid request.
A valid API key is required to access this resource.
The time group/fetch client id pair was not found.
This team has a registered posted time webhook. Switching to use fetch client is required.
An unexpected error occured.
Request samples
- Payload
{- "timeGroupId": "string",
- "status": "SUCCESS",
- "message": "string"
}Subscribe to be notified when a user posts time information to your team.
WiseTime will call your webhook with a payload of the posted time information. See the posted time webhook documentation for details. Each team is limited to one webhook callback.
Authorizations:
Request Body schema: application/json
| callbackUrl required | string The webhook URL that WiseTime will call to notify you of user posted time. |
| callerKey | string WiseTime will send this key back to you when it calls your webhook. That way you can authenticate that the request comes from WiseTime. |
Responses
Webhook subscription successfully created.
Invalid request. Callback URL is required.
A valid API key is required to access this resource.
This team already has a registered webhook or fetch client.
An unexpected error occured.
Request samples
- Payload
{- "callbackUrl": "string",
- "callerKey": "string"
}Response samples
- 200
{ }Delete existing webhook for given connector (specified by api key), unsubscribing your application from posted time notifications.
WiseTime will stop calling your webhook when users post time to your team.
Authorizations:
Request Body schema: application/json
Responses
Webhook successfully deleted.
A valid API key is required to access this resource.
No Webhook found for provided api key.
An unexpected error occured.
Request samples
- Payload
{ }Response samples
- 200
{ }Returns list of posted time with pending or success status.
Returns all time groups for team in descending order of submission time starting from now. This is not a long polling endpoint.
Authorizations:
query Parameters
| limit | integer Maximum number of items to return. Should be between 1 and 500. Default is 100. |
| submittedBefore | integer Filter response to return only time groups submitted before requested timestamp. If empty - returns latest time groups. Note that the submisisonTime may be the same for multiple time groups as users may submit more than 1 time group as a single operation. Measured in milliseconds since the Epoch. |
Responses
List of time groups.
Invalid request.
A valid API key is required to access this resource.
An unexpected error occured.
Response samples
- 200
[- {
- "callerKey": "string",
- "groupId": "string",
- "description": "string",
- "totalDurationSecs": 0,
- "groupName": "string",
- "narrativeType": "NARRATIVE_AND_TIME_ROW_ACTIVITY_DESCRIPTIONS",
- "status": "PENDING",
- "submissionTime": null,
- "tags": [
- {
- "name": "string",
- "path": "string",
- "description": "string"
}
], - "timeRows": [
- {
- "activity": "string",
- "description": "string",
- "activityHour": 0,
- "firstObservedInHour": 0,
- "durationSecs": 0,
- "submittedDate": null,
- "modifier": "string",
- "activityTypeCode": "string",
- "source": "WT_DESKTOP"
}
], - "user": {
- "name": "string",
- "email": "string",
- "externalId": "string",
- "businessRole": "string",
- "experienceWeightingPercent": 0
}, - "originatingUser": {
- "name": "string",
- "email": "string",
- "externalId": "string",
- "businessRole": "string",
- "experienceWeightingPercent": 0
}, - "durationSplitStrategy": "DIVIDE_BETWEEN_TAGS"
}
]