Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
Casb
Posture
Webhooks

Jobs

Create webhook jobs
client.zeroTrust.casb.posture.webhooks.jobs.create(JobCreateParams { account_id, finding_instance_ids, webhook_ids } params, RequestOptionsoptions?): JobCreateResponse { created, failed }
POST/accounts/{account_id}/data-security/posture/webhooks/jobs
ModelsExpand Collapse
JobCreateResponse { created, failed }
created: Array<Created>

Successfully created webhook jobs.

id: string

Unique identifier for the webhook job.

formatuuid
asset_data: Record<string, unknown>

Asset data associated with this webhook job.

created_at: string

When the webhook job was created.

formatdate-time
integration_id: string

ID of the integration.

formatuuid
last_updated_at: string

When the webhook job was last updated.

formatdate-time
parameters: Parameters { finding_instance_id }

Parameters for a webhook job.

finding_instance_id: string

ID of the finding instance.

formatuuid
status: "pending" | "processing" | "completed" | "failed"

Status of a webhook job.

One of the following:
"pending"
"processing"
"completed"
"failed"
triggered_by_actor: "user" | "account_token"

Type of actor that triggered the webhook job.

One of the following:
"user"
"account_token"
triggered_by_id: string

ID of the actor that triggered the job.

webhook_id: string

ID of the webhook configuration.

formatuuid
failure_details?: Record<string, unknown>

Additional details about the failure.

failure_reason?: "Permission Denied" | "Integration Unavailable" | "Service Temporarily Unavailable" | "System Error"

Reason for webhook job failure.

One of the following:
"Permission Denied"
"Integration Unavailable"
"Service Temporarily Unavailable"
"System Error"
failed: Array<Failed>

Failed webhook job creation attempts.

error: string

Error message describing the failure.

finding_instance_id: string

ID of the finding instance that failed to create a webhook job.

formatuuid
webhook_id: string

ID of the webhook configuration.

formatuuid