Skip to main content
POST
https://tickward.com/api/v1
/
webhooks
/
{webhook_id}
/
test
Send test webhook
curl --request POST \
  --url https://tickward.com/api/v1/webhooks/{webhook_id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "object": "webhook_test",
  "endpoint": {
    "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"
  },
  "delivery": {
    "id": "<string>",
    "object": "webhook_delivery",
    "endpoint_id": "<string>",
    "event_id": "<string>",
    "attempt_count": 1,
    "next_attempt_at": "2026-10-10T09:30:00.000Z",
    "last_attempt_at": "2026-10-10T09:30:00.000Z",
    "delivered_at": "2026-10-10T09:30:00.000Z",
    "failed_at": "2026-10-10T09:30:00.000Z",
    "response_status": 123,
    "error": "<string>",
    "created_at": "2026-10-10T09:30:00.000Z",
    "updated_at": "2026-10-10T09:30:00.000Z"
  }
}

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._:-]+$

Path Parameters

webhook_id
string
required

Webhook endpoint id.

Body

application/json
event_type
enum<string>

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.

object
enum<string>
required
Available options:
webhook_test
endpoint
object
required
delivery
object
required