Skip to content
Docs
GitHub

Create a per-task push-notification config

Preview

Manage execution sessions and rooms, and their files, tasks, storage, databases and managed sandboxes.

Public APIEverruns Cloud and self-hosted Platform

POST/v1/sessions/{session_id}/tasks/{task_id}/push-configs

See authentication for credentials and permissions.

session_id
required
string

Session ID

task_id
required
string

Task ID

Media typeapplication/json

Request body for creating a per-task push config.

object
event_filter

Events that trigger delivery. Defaults to ["terminal"].

Array<string> | null
secret

Optional HMAC-SHA256 signing secret (never returned once set).

string | null

Example

whsec_example_signing_secret_placeholder
url
required

URL to POST task events to.

string

Example

https://hooks.example.com/everruns/tasks

Responses

200Created push config

Created push config

Media typeapplication/json

Public view of a per-task push config. The stored secret is NEVER returned — only has_secret signals whether one is configured.

object
created_at
required

When the config was created (RFC 3339).

string format: date-time
event_filter
required

Events that trigger delivery (terminal, awaiting_input, message).

Array<string>
has_secret
required

Whether a signing secret is configured (the secret itself is never returned).

boolean
id
required

Public identifier (tpc_<32-hex-chars>).

string
updated_at
required

When the config was last updated (RFC 3339).

string format: date-time
url
required

Target URL that receives POST deliveries.

string

Example

{
"created_at": "2026-07-11T00:00:00Z",
"has_secret": true,
"id": "tpc_9f8c2b1a4e7d4c3b8a1f2e3d4c5b6a7f",
"updated_at": "2026-07-11T00:00:00Z",
"url": "https://hooks.example.com/everruns/tasks"
}
400Invalid request (bad URL or event_filter)

Invalid request (bad URL or event_filter)

404Session or task not found

Session or task not found