Signals Docs
Webhooks
Webhooks

Schemas

CreateWebhookEndpointRequest

events
​string[] · required
scope_type
​WebhookEndpointScopeType · enum · required
Enum values:
organization
trunk
subaccount
timeout_seconds
​integer · int32 · min: 0 · required
url
​string · uri · required
failover_url
​string | null · uri
scope_id
​string | null

CreatedWebhookEndpoint

​WebhookEndpoint · required
secret
​string | null · required
secret_unavailable
​boolean · required

NumberBlockConsumer

count
​integer · int32 · min: 0 · required
id
​string · required
name
​string · required
type
​string · required

Problem

The problem document every error response carries.
code
​string · required
detail
​string · required
request_id
​string · required
status
​integer · int32 · min: 0 · required
title
​string · required
type
​string · required
​ProjectRef[]
caused_by
​string
changed_resources
​string[]
expensive_filter
​string
reason
​string
remediation
​string

ProjectRef

id
​string · required
name
​string · required

ReplayWebhookEventsRequest

delivery_ids
​string[] · required
event_types
​string[] · required
preview
​boolean · required
window_from
​string · date-time · required
window_to
​string · date-time · required

UpdateWebhookEndpointRequest

Every field is optional and at least one is required; a field left out keeps its value.
events
​array | null
failover_url
​string | null · uri

Null clears the failover URL; leaving the field out keeps it.

is_active
​boolean | null
timeout_seconds
​integer | null · int32 · min: 0
url
​string | null · uri

WebhookDelivery

attempt
​integer · int32 · required
attempted_at
​string · date-time · required
call_sequence
​integer | null · int64 · required
duration_ms
​integer | null · int32 · required
endpoint_id
​string · required
endpoint_url
​string · uri · required
error
​string | null · required
event_id
​string · required
event_type
​string · required
id
​string · required
max_attempts
​integer · int32 · required
next_retry_at
​string | null · date-time · required
replay_request_id
​string | null · required
replay_requested_by
​string | null · required
replayable_until
​string | null · date-time · required
​required
result
​WebhookDeliveryResult · enum · required
Enum values:
delivered
retrying
exhausted
status_code
​integer | null · int32 · required

WebhookDeliveryAttempt

attempt
​integer · int32 · required
attempted_at
​string | null · date-time · required
duration_ms
​integer | null · int32 · required
error
​string | null · required
response_excerpt
​string | null · required
scheduled_for
​string | null · date-time · required
status_code
​integer | null · int32 · required
target
​WebhookDeliveryTarget · enum · required
Enum values:
primary
failover

WebhookDeliveryDetail

attempt
​integer · int32 · required
attempted_at
​string · date-time · required
call_sequence
​integer | null · int64 · required
duration_ms
​integer | null · int32 · required
endpoint_id
​string · required
endpoint_url
​string · uri · required
error
​string | null · required
event_id
​string · required
event_type
​string · required
id
​string · required
max_attempts
​integer · int32 · required
next_retry_at
​string | null · date-time · required
replay_request_id
​string | null · required
replay_requested_by
​string | null · required
replayable_until
​string | null · date-time · required
​required
result
​WebhookDeliveryResult · enum · required
Enum values:
delivered
retrying
exhausted
status_code
​integer | null · int32 · required
​WebhookDeliveryAttempt[] · required
request_body
​string · required
​object · required
response_excerpt
​string | null · required
​object | null · required

WebhookDeliveryList

​WebhookDelivery[] · required

WebhookDeliveryResource

id
​string · required
label
​string | null · required
type
​string · required

WebhookDeliveryResult

string · enum
Enum values:
delivered
retrying
exhausted

WebhookDeliveryTarget

string · enum
Enum values:
primary
failover

WebhookEndpoint

created_at
​string · date-time · required
created_by
​string | null · required
disabled_at
​string | null · date-time · required
disabled_reason
​string | null · required
events
​string[] · required
failover_url
​string | null · uri · required
​WebhookEndpointHealth · required
id
​string · required
is_active
​boolean · required
previous_retires_at
​string | null · date-time · required
retained_events
​integer | null · int64 · min: 0 · required
retention_ends_at
​string | null · date-time · required
​WebhookEndpointScope · required
secret_hint
​string · required
secret_rotated_at
​string · date-time · required
timeout_seconds
​integer · int32 · min: 0 · required
url
​string · uri · required

WebhookEndpointHealth

attempts
​integer · int64 · min: 0 · required
delivered
​integer · int64 · min: 0 · required
exhausted
​integer · int64 · min: 0 · required
failing_since
​string | null · date-time · required
failover_attempts
​integer | null · int64 · min: 0 · required
failover_delivered
​integer | null · int64 · min: 0 · required
last_attempt_at
​string | null · date-time · required
last_error
​string | null · required
last_status_code
​integer | null · int32 · min: 0 · required
p50_ms
​integer | null · int32 · min: 0 · required
p95_ms
​integer | null · int32 · min: 0 · required
p99_ms
​integer | null · int32 · min: 0 · required
recent_attempts
​integer · int64 · min: 0 · required
recent_failures
​integer · int64 · min: 0 · required
retrying
​integer · int64 · min: 0 · required
status
​WebhookEndpointHealthStatus · enum · required
Enum values:
healthy
degraded
disabled
window_hours
​integer · int32 · min: 0 · required

WebhookEndpointHealthStatus

string · enum
Enum values:
healthy
degraded
disabled

WebhookEndpointList

​WebhookEndpoint[] · required

WebhookEndpointScope

id
​string | null · required
name
​string | null · required
type
​WebhookEndpointScopeType · enum · required
Enum values:
organization
trunk
subaccount

WebhookEndpointScopeType

string · enum
Enum values:
organization
trunk
subaccount

WebhookReplayPreview

events
​integer · int64 · min: 0 · required
rate_per_second
​integer · int32 · min: 0 · required
window_from
​string · date-time · required
window_to
​string · date-time · required

WebhookReplayQueued

replay_request_id
​string · required

WebhookTestCheck

detail
​string · required
duration_ms
​integer | null · int32 · min: 0 · required
outcome
​WebhookTestOutcome · enum · required
Enum values:
ok
failed
skipped
step
​WebhookTestStep · enum · required
Enum values:
dns
connect
tls
request
response
failover

WebhookTestOutcome

string · enum
Enum values:
ok
failed
skipped

WebhookTestResult

​WebhookTestCheck[] · required
delivery_id
​string · required
event_id
​string · required
request_body
​string · required
status_code
​integer | null · int32 · min: 0 · required

WebhookTestStep

string · enum
Enum values:
dns
connect
tls
request
response
failover