Webhooks

Create a webhook

Changed on

Creating a webhook generates a new token which can be used to verify that the webhook being sent was sent by Clockify, as it will always be present in the header.

post/v1/workspaces/{workspaceId}/webhooks

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/webhooks
  • Auth: one of:
    • API key in header x-api-key
    • API key in header x-addon-token

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Request body

namestring

Represents a webhook name.

triggerSourcestring[] required

Represents a list of trigger sources.

triggerSourceType'PROJECT_ID' | 'USER_ID' | 'TAG_ID' | 'TASK_ID' | 'WORKSPACE_ID' | 'ASSIGNMENT_ID' | 'EXPENSE_ID' required

Represents a webhook event trigger source type.

urlstring required

Represents a webhook target url.

webhookEvent'NEW_PROJECT' | 'NEW_TASK' | 'NEW_CLIENT' | 'NEW_TIMER_STARTED' | 'TIMER_STOPPED' | 'TIME_ENTRY_UPDATED' | 'TIME_ENTRY_DELETED' | 'TIME_ENTRY_SPLIT' | 'NEW_TIME_ENTRY' | 'TIME_ENTRY_RESTORED' | 'NEW_TAG' | 'USER_DELETED_FROM_WORKSPACE' | 'USER_JOINED_WORKSPACE' | 'USER_DEACTIVATED_ON_WORKSPACE' | 'USER_ACTIVATED_ON_WORKSPACE' | 'USER_EMAIL_CHANGED' | 'USER_UPDATED' | 'NEW_INVOICE' | 'INVOICE_UPDATED' | 'NEW_APPROVAL_REQUEST' | 'APPROVAL_REQUEST_STATUS_UPDATED' | 'TIME_OFF_REQUESTED' | 'TIME_OFF_REQUEST_UPDATED' | 'TIME_OFF_REQUEST_APPROVED' | 'TIME_OFF_REQUEST_REJECTED' | 'TIME_OFF_REQUEST_STARTED' | 'TIME_OFF_REQUEST_WITHDRAWN' | 'BALANCE_UPDATED' | 'TAG_UPDATED' | 'TAG_DELETED' | 'TASK_UPDATED' | 'CLIENT_UPDATED' | 'TASK_DELETED' | 'CLIENT_DELETED' | 'EXPENSE_RESTORED' | 'ASSIGNMENT_CREATED' | 'ASSIGNMENT_DELETED' | 'ASSIGNMENT_PUBLISHED' | 'ASSIGNMENT_UPDATED' | 'EXPENSE_CREATED' | 'EXPENSE_DELETED' | 'EXPENSE_UPDATED' | 'PROJECT_UPDATED' | 'PROJECT_DELETED' | 'USER_GROUP_CREATED' | 'USER_GROUP_UPDATED' | 'USER_GROUP_DELETED' | 'USERS_INVITED_TO_WORKSPACE' | 'LIMITED_USERS_ADDED_TO_WORKSPACE' | 'COST_RATE_UPDATED' | 'BILLABLE_RATE_UPDATED' required

Represents a webhook event type.

Example request

{
  "name": "stripe",
  "triggerSource": [
    "54a687e29ae1f428e7ebe909",
    "87p187e29ae1f428e7ebej56"
  ],
  "triggerSourceType": "PROJECT_ID",
  "url": "https://example-clockify.com/stripeEndpoint",
  "webhookEvent": "NEW_PROJECT"
}

Response

Created

WebhookDtoV1 required(unresolved $ref)

Changes

  • ebb1ceff675dRevision changes
    • warning

      added the new DEFAULT_BILLABLE_PROJECT enum value to the / response property for the response status

    • warning

      added the new TIME_ENTRY_ROUNDING enum value to the / response property for the response status

  • db564b054b84Revision changes
    • warning

      added the new APPROVAL_REQUEST_HISTORY enum value to the / response property for the response status

    • warning

      added the new TOIL enum value to the / response property for the response status

    • warning

      added the new TOIL_POLICY enum value to the / response property for the response status

    • warning

      added the new TOIL_REQUEST enum value to the / response property for the response status

    • info

      added the optional property to the response with the status

    • info

      response property deliveryEnabled deprecated

    • info

      response property enabled deprecated

    • info

      response property planEnabled deprecated