Checking authentication...

Webhooks

Manage webhooks for event notifications

5 tools

List Webhooks

Read Idempotent

POST /v1/tools/tape/listWebhooks

List all webhooks configured for a Tape app, including their status (verified/unverified), event types, and URLs. Use to find hook_ids for managing existing webhooks.

Parameters

Name	Type	Required	Description
`app_id`	number	required	The app ID to list webhooks for (from getApp or listApps).

Request

curl -X POST https://api.syncello.io/v1/tools/tape/listWebhooks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "app_id": "123"
}'

Response

{
  "webhooks": [
    {
      "hook_id": 55220,
      "app_id": 500123,
      "status": "active",
      "num_failed_executions": 0,
      "type": "record.create",
      "url": "https://hooks.example.com/tape/deals"
    },
    {
      "hook_id": 55221,
      "app_id": 500123,
      "status": "inactive",
      "num_failed_executions": 0,
      "type": "record.update",
      "url": "https://hooks.example.com/tape/deals"
    }
  ],
  "total": 2
}

Try It

Try it

Create Webhook

Write

POST /v1/tools/tape/createWebhook

Create a webhook subscription for a single Tape app event type. Tape registers one webhook per event type, so pass exactly one `event_type` per call — call again to subscribe to additional events. The webhook is created in INACTIVE state and must be verified before it starts receiving events: after creation, call tape_requestWebhookVerification to start the verification process, then tape_validateWebhookVerification with the code received at the webhook URL. Valid event_type values: "record.create", "record.update", "record.delete", "record.restore", "comment.create", "comment.delete".

Parameters

Name	Type	Required	Description
`app_id`	number	required	The app ID to create the webhook for (from getApp or listApps).
`url`	string	required	The webhook URL that will receive event payloads (must be publicly accessible HTTPS endpoint).
`event_type`	string	required	The single event type to subscribe to. Tape creates one webhook per event type. app.update fires when the app's fields or settings change (there is no app.delete event — a deleted app simply stops sending webhooks). Values: record.create, record.update, record.delete, record.restore, comment.create, comment.delete, app.update

Request

curl -X POST https://api.syncello.io/v1/tools/tape/createWebhook \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "app_id": "123",
  "url": "example",
  "event_type": "record.create"
}'

Response

{
  "hook_id": 55220,
  "app_id": 500123,
  "status": "inactive",
  "num_failed_executions": 0,
  "type": "record.create",
  "url": "https://hooks.example.com/tape/deals",
  "note": "Webhook created but not active. Use requestWebhookVerification to activate it."
}

Try It

Try it

Delete Webhook

Destructive

POST /v1/tools/tape/deleteWebhook

Permanently delete a Tape webhook. The webhook will immediately stop receiving events. This action cannot be undone. Use tape_listWebhooks first to find the hook_id.

Parameters

Name	Type	Required	Description
`hook_id`	number	required	The webhook ID to delete (from listWebhooks).

Request

curl -X POST https://api.syncello.io/v1/tools/tape/deleteWebhook \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "hook_id": "123"
}'

Response

{
  "hook_id": 55220,
  "status": "inactive",
  "num_failed_executions": 0,
  "type": "record.create",
  "url": "https://hooks.example.com/tape/deals"
}

Try It

Try it

Request Webhook Verification

Write

POST /v1/tools/tape/requestWebhookVerification

Send a verification code to a Tape webhook URL. This is step 1 of webhook activation: the webhook endpoint receives a POST with a verification code. Step 2 is to call tape_validateWebhookVerification with that code to activate the webhook. The webhook URL must capture and store the verification code.

Parameters

Name	Type	Required	Description
`hook_id`	number	required	The webhook ID to verify (from createWebhook or listWebhooks). Must be in unverified state.

Request

curl -X POST https://api.syncello.io/v1/tools/tape/requestWebhookVerification \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "hook_id": "123"
}'

Response

{
  "hook_id": 55220,
  "note": "Verification code sent to webhook URL. Use validateWebhookVerification with the received code."
}

Try It

Try it

Validate Webhook Verification

Write

POST /v1/tools/tape/validateWebhookVerification

Activate a Tape webhook by submitting the verification code that was sent to the webhook URL. This is step 2 of webhook activation (after tape_requestWebhookVerification). On success, the webhook becomes active and starts receiving events for its subscribed event type.

Parameters

Name	Type	Required	Description
`hook_id`	number	required	The webhook ID to validate (from createWebhook or listWebhooks).
`code`	string	required	The verification code that was POSTed to the webhook URL by requestWebhookVerification.

Request

curl -X POST https://api.syncello.io/v1/tools/tape/validateWebhookVerification \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "hook_id": "123",
  "code": "example"
}'

Response

{
  "hook_id": 55220,
  "app_id": 500123,
  "status": "active",
  "type": "record.create",
  "url": "https://hooks.example.com/tape/deals",
  "note": "Webhook verified and now active!"
}