Grain: Create Hook

Create a webhook subscription using hook_type and hook_url.

Tool ID: grain_create_hook

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'grain_create_hook',
  {
    "hook_url": "https://example.com",
    "hook_type": "recording_added"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute grain_create_hook --input '{
  "hook_url": "https://example.com",
  "hook_type": "recording_added"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "id": "id_123",
    "enabled": true,
    "hook_url": "https://example.com"
  }
}

Use deepline describe grain_create_hook --json for the latest machine-readable contract.

Input reference

Create a webhook subscription using hook_type and hook_url. Grain tests the URL, which must return a 2xx response.

Name	Type	Required	Default	Details
`payload.hook_url`	`string`	Yes	—	Endpoint to be called when the event is triggered. A reachability test is made to the provided url on creation. The endpoint must respond with a 2xx status in order to successfully create the hook.
`payload.hook_type`	`"recording_added" \| "recording_updated" \| "recording_deleted" \| "highlight_added" \| "highlight_updated" \| "highlight_deleted" \| "story_added" \| "story_updated" \| "story_deleted" \| "upload_status"`	Yes	—	Type of notifications the hook will be sent. Allowed: `recording_added`, `recording_updated`, `recording_deleted`, `highlight_added`, `highlight_updated`, `highlight_deleted`, `story_added`, `story_updated`, `story_deleted`, `upload_status`.
`payload.include`	`object`	No	—	—

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.id`	`string`	No	—	id of the hook
`result.data.enabled`	`boolean`	No	—	Whether the hook is enabled or not
`result.data.hook_url`	`string`	No	—	URL to which Grain will post to
`result.data.hook_type`	`"recording_added" \| "recording_updated" \| "recording_deleted" \| "highlight_added" \| "highlight_updated" \| "highlight_deleted" \| "story_added" \| "story_updated" \| "story_deleted" \| "upload_status"`	No	—	Type of notifications the hook will be sent. Allowed: `recording_added`, `recording_updated`, `recording_deleted`, `highlight_added`, `highlight_updated`, `highlight_deleted`, `story_added`, `story_updated`, `story_deleted`, `upload_status`.
`result.data.include`	`object`	No	—	recording_added recording_updated Recording Include the hook was created with. highlight_added highlight_updated Highlight Include the hooks was created with. recording_deleted highlight_deleted story_added story_updated story_deleted upload_status Always an empty object
`result.data.inserted_at`	`string`	No	—	UTC datetime of when the hook was created
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation