Skip to main content
POST
https://tickward.com/api/v1
/
webhooks
Create webhook endpoint
curl --request POST \
  --url https://tickward.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>"
}
'
{
  "id": "wh_123",
  "object": "webhook_endpoint",
  "name": "Production automation",
  "url": "https://example.com/tickward/webhooks",
  "event_types": [],
  "failure_count": 1,
  "created_at": "2026-10-10T09:30:00.000Z",
  "updated_at": "2026-10-10T09:30:00.000Z",
  "disabled_at": "2026-10-10T09:30:00.000Z",
  "last_delivered_at": "2026-10-10T09:30:00.000Z",
  "last_failed_at": "2026-10-10T09:30:00.000Z",
  "signing_secret": "whsec_example"
}

Authorizations

​
Authorization
string
header
default:tw_your_api_key
required

Use a tickward API key from Settings. API keys start with tw_. Store keys as secrets and send them as Authorization: Bearer <key>.

Headers

​
Idempotency-Key
string

Optional for POST, PATCH, and DELETE requests. Generate a random UUID with an operation prefix, for example timer-create-${crypto.randomUUID()}. Reuse the same key with the same method, path, query, and JSON body to safely retry one logical write for up to 24 hours. Reusing it with a different request returns 409. The server stores only a hash of the key.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9._:-]+$

Body

application/json
​
name
string
required
Required string length: 1 - 80
​
url
string<uri>
required
​
event_types
enum<string>[]

If omitted, the endpoint receives every supported event type.

Required array length: 1 - 11 elements

Event type delivered to webhook endpoints.

Available options:
project.created,
project.updated,
project.deleted,
timer.created,
timer.updated,
timer.archived,
timer.restored,
timer.deleted,
timer.ended,
share.created,
share.deleted

Response

Successful response.

​
id
string
required
Example:

"wh_123"

​
object
enum<string>
required
Available options:
webhook_endpoint
​
name
string
required
Example:

"Production automation"

​
url
string<uri>
required
Example:

"https://example.com/tickward/webhooks"

​
event_types
enum<string>[]
required

Event type delivered to webhook endpoints.

Available options:
project.created,
project.updated,
project.deleted,
timer.created,
timer.updated,
timer.archived,
timer.restored,
timer.deleted,
timer.ended,
share.created,
share.deleted
​
status
enum<string>
required
Available options:
active,
disabled
​
failure_count
integer
required
Required range: x >= 0
​
created_at
string<date-time>
required

ISO 8601 datetime string. Prefer UTC with Z or an explicit offset.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Example:

"2026-10-10T09:30:00.000Z"

​
updated_at
string<date-time>
required

ISO 8601 datetime string. Prefer UTC with Z or an explicit offset.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Example:

"2026-10-10T09:30:00.000Z"

​
disabled_at
string<date-time> | null
required
Example:

"2026-10-10T09:30:00.000Z"

​
last_delivered_at
string<date-time> | null
required
Example:

"2026-10-10T09:30:00.000Z"

​
last_failed_at
string<date-time> | null
required
Example:

"2026-10-10T09:30:00.000Z"

​
signing_secret
string
required

Shown only once. Store it and use it to verify tickward-signature.

Example:

"whsec_example"