List webhook-trigger subscriptions

GET

/v1/webhook-subscriptions

const url = 'https://dev-api.infiniteaudience.ai/v1/webhook-subscriptions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dev-api.infiniteaudience.ai/v1/webhook-subscriptions \
  --header 'Authorization: Bearer <token>'

Requires ‘account’ scope, or an OAuth access token — in the OAuth case, this list is scoped to subscriptions created by your own connection only.

Authorizations

bearerAuth

Responses

200

Subscriptions visible to the caller, most recent first.

application/json

object

subscriptions

required

Array<object>

A durable event-trigger subscription (e.g. a Zap that is turned on). Delivery is retried with exponential backoff; see the Triggers tag for the ownership model.

object

required

string

target_url

required

string format: uri

events

required

Array<string>

Allowed values: segment.ready segment.failed delivery.completed delivery.failed

status

required

“disabled” is set automatically after 20 consecutive dead-lettered deliveries; “revoked” is explicit — owner action, disconnecting the integration, or the target endpoint itself returning 410 Gone.

string

Allowed values: active disabled revoked

created_at

required

string format: date-time

created_by

required

Identifier of the creating caller.

string

last_delivery_at

required

string | null format: date-time

consecutive_failure_count

required

Resets to 0 on any successful delivery; reaching 20 auto-disables the subscription.

integer

Example

{
  "subscriptions": [
    {
      "events": [
        "segment.ready"
      ],
      "status": "active"
    }
  ]
}

401

Missing or invalid Bearer token. Obtain one via POST /v1/auth/token. When a token was supplied but rejected, code distinguishes TOKEN_EXPIRED (the token’s lifetime has passed — request a new one via POST /v1/auth/token and retry) from TOKEN_INVALID (malformed or revoked — re-authenticate).

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

{
  "error": "Unauthorized: Missing or invalid Authorization header"
}

{
  "error": "Unauthorized",
  "code": "TOKEN_EXPIRED",
  "message": "Your session has expired. Please sign in again."
}

403

Token is valid but lacks the required scope for this endpoint. Check the endpoint description for the required scope (discovery, purchase, or account).

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

missing_scope

{
  "error": "SCOPE_REQUIRED",
  "message": "This endpoint requires the purchase scope."
}