Webhooks

Update Webhook

Update a webhook's events or scope. The targetUrl cannot be changed and is ignored if sent; the handshake is repeated against the existing URL to confirm it is still reachable. Send X-Skip-Handshake: 1 to skip it.

put/hooks/{hook_id}

Request

Base URL
https://api.everhour.com
Auth
API key in header X-Api-Key
TypeScript
https://skmtc.dev/everhour/apis/everhour-api/docs/hooks/:hook_id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

hook_idnumber required

Example:280382

Webhook ID

Request body

eventsstring[] required

Replacement list of events. targetUrl and scope cannot be changed after creation.

Example request

{
  "events": [
    "api:time:updated"
  ]
}

Response

idnumber required

Webhook ID

targetUrlstring required

eventsstring[] required

projectstring nullable

You can receive events only for specific project

activeboolean

createdAtstring required

Datetime when webhook was created (format: Y-m-d H:i:s)

lastUsedAtstring required

Datetime when webhook was last used (format: Y-m-d H:i:s)

Example response

{
  "id": 12345,
  "targetUrl": "https://some-secure-endpoint.com/path",
  "events": [
    "api:time:updated"
  ],
  "project": "ev:12345657890",
  "active": true,
  "createdAt": "2018-03-05 16:17:14",
  "lastUsedAt": "2018-03-05 20:01:58"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.