Operations

Get Operation status

Check status of an async Rule operation.

Operation Lifecycle

Operations transition from PENDING to COMPLETED status within 30-60 seconds of a Rule mutation being accepted (202 Accepted with Operation-Id header).

get/v1/Webhooks/Operations/{operationId}

Request

  • Base URL
    https://webhooks.twilio.com
  • Auth
    HTTP basic

Response

Operation status

idstring required

Unique operation identifier (TypeID/TTID format)

statusUrlstring uri required

URL to poll for operation status (same as Location header in 202 response)

status'PENDING' | 'RUNNING' | 'COMPLETED' | 'CANCELLED' | 'FAILED' required

Current state of the operation:

  • PENDING: Accepted, not yet started
  • RUNNING: Propagating to all regions (typically 30-60 seconds)
  • COMPLETED: Rule active globally
  • CANCELLED: Operation was cancelled before completion
  • FAILED: Operation could not complete; see error field for details
resourceIdstring

ID of the affected resource

createdAtstring date-time required
completedAtstring date-time
retentionPeriodstring duration required

ISO-8601 duration for how long this Operation record is retained after creation (fixed at 7 days)

Example response

{
  "retentionPeriod": "P7D"
}

Changes

No recorded changes to this operation across all 1 revision of this API.