0.x — pre-release, no compatibility promise yet.What this means
Events
What this is: the event vocabulary — the names you tick when you create a webhook.
When you need it: choosing events for POST /v1/webhooks.
curl "$TASKSMATE_API_URL/v1/webhooks/events" -H "Authorization: Bearer $TASKSMATE_TOKEN"Dotted event names (task.updated) or <resource>.* wildcards (task.*); GET /v1/webhooks/events lists the vocabulary. A status change is task.updated with status in data.before / data.after. Each name below links to its payload in the reference.
Availability
| Event | Sent when |
|---|---|
availability.created | A member recorded days they are unavailable. |
availability.deleted | A member's unavailable days were removed. |
availability.updated | A member's unavailable days changed. |
Designation
| Event | Sent when |
|---|---|
designation.created | A designation was created. |
designation.deactivated | A designation was deactivated. |
designation.updated | A designation changed. |
designation.visibility_changed | A designation was shown or hidden. |
Goal
| Event | Sent when |
|---|---|
goal.closed | A project goal was closed. |
goal.created | A project goal was created. |
goal.deleted | A project goal was deleted. |
goal.moved | A goal moved to another project. |
goal.reopened | A project goal was reopened. |
goal.reordered | A project's goal order changed. |
goal.updated | A project goal changed. |
Invite
| Event | Sent when |
|---|---|
invite.accepted | An invitation was accepted. |
invite.created | An invitation to the organization was sent. |
invite.external_override | An invitation outside the verified domains was allowed by an admin. |
invite.rejected | An invitation was declined. |
invite.revoked | An invitation was withdrawn. |
invite.updated | An invitation was changed. |
Member
| Event | Sent when |
|---|---|
member.added | Someone joined the organization. |
member.auto_joined | Someone joined the organization through a verified domain. |
member.designation_changed | A member's designation changed. |
member.removed | Someone left or was removed from the organization. |
member.role_changed | A member's organization role changed. |
Milestone
| Event | Sent when |
|---|---|
milestone.closed | A team milestone was closed. |
milestone.created | A team milestone was created. |
milestone.deleted | A team milestone was deleted. |
milestone.reopened | A team milestone was reopened. |
milestone.updated | A team milestone changed. |
Org
| Event | Sent when |
|---|---|
org.deleted | The organization was deleted. |
org.domain_added | A domain was added to the organization. |
org.domain_removed | A domain was removed. |
org.domain_verified | A domain was verified. |
org.join_request_decided | A request to join the organization was approved or declined. |
org.settings_changed | The organization's settings changed. |
org.updated | The organization's name or description changed. |
Project
| Event | Sent when |
|---|---|
project.created | A project was created. |
project.delegation_changed | Whether a project's editors may add members changed. |
project.deleted | A project was deleted. |
project.leads_changed | A project's leads changed. |
project.member_added | Someone was added to a project. |
project.member_removed | Someone was removed from a project. |
project.member_role_changed | A project member's role changed. |
project.member_updated | A project member's details changed. |
project.owner_transferred | A project's ownership moved to another member. |
project.reordered | The organization's project order changed. |
project.updated | A project's fields changed. |
project.visibility_changed | A project became public or private. |
Roadmap journey
| Event | Sent when |
|---|---|
roadmap_journey.created | A roadmap journey was created. |
roadmap_journey.deleted | A roadmap journey was deleted. |
roadmap_journey.updated | A roadmap journey changed. |
Roadmap stop
| Event | Sent when |
|---|---|
roadmap_stop.created | A roadmap stop was created. |
roadmap_stop.deleted | A roadmap stop was deleted. |
roadmap_stop.milestone_pinned | A milestone was pinned to a roadmap stop. |
roadmap_stop.milestone_unpinned | A milestone was unpinned from a roadmap stop. |
roadmap_stop.task_attached | A task was attached to a roadmap stop. |
roadmap_stop.task_detached | A task was detached from a roadmap stop. |
roadmap_stop.updated | A roadmap stop changed. |
Service account
| Event | Sent when |
|---|---|
service_account.created | A service account was created. |
service_account.deactivated | A service account was deactivated and its tokens revoked. |
service_account.renamed | A service account was renamed. |
Sprint
| Event | Sent when |
|---|---|
sprint.created | A team sprint was created. |
sprint.deleted | A team sprint was deleted. |
sprint.updated | A team sprint changed. |
Task
| Event | Sent when |
|---|---|
task.attachment_added | A file was attached to a task. |
task.attachment_removed | An attachment was removed from a task. |
task.comment_added | A comment was posted on a task. |
task.comment_removed | A comment on a task was deleted. |
task.comment_updated | A comment on a task was edited. |
task.created | A task was created. |
task.deleted | A task was deleted. |
task.dependency_added | A dependency was added to a task. |
task.dependency_removed | A dependency was removed from a task. |
task.moved | A task moved to another project (or out of one). |
task.restricted | Who may see a task changed (restricted_to). |
task.subtask_added | A subtask was linked under a task. |
task.subtask_removed | A subtask was unlinked from a task. |
task.updated | A task's fields changed (status, title, assignee, dates, …); data.before / data.after name the fields. |
Team
| Event | Sent when |
|---|---|
team.created | A team was created. |
team.deleted | A team was deleted. |
team.member_added | Someone joined a team. |
team.member_removed | Someone left a team. |
team.member_role_changed | A team member's role changed. |
team.updated | A team's fields changed. |
Token
| Event | Sent when |
|---|---|
token.auth_failed | A request presented an expired or revoked access token. |
token.created | An access token was created. |
token.renamed | An access token was renamed. |
token.revoked | An access token was revoked. |
token.rotated | An access token was rotated (the old one works 60 seconds more). |
Webhook
| Event | Sent when |
|---|---|
webhook.created | A webhook was created. |
webhook.deleted | A webhook was deleted. |
webhook.delivery_replayed | A webhook delivery was sent again. |
webhook.disabled | A webhook was disabled after repeated failed deliveries, or because its endpoint answered 410 Gone. |
webhook.paused | A webhook was paused. |
webhook.resumed | A webhook was resumed (or re-enabled after being disabled). |
webhook.rotated | A webhook's signing secret was rotated (the old one signs too for 24 hours). |
webhook.test | A test delivery (POST /v1/webhooks/{subscription_id}/test); data names the webhook itself. Never retried. |
webhook.updated | A webhook's name, URL, events or projects changed. |