Skip to main content

Webhook

Represents a webhook type.

type Webhook {
  id: ID!
  name: String
  description: String
  url: String
  secret: String
  isEnabled: Boolean
  events: [WebhookEventSubscription!]
  consecutiveFailures: Int!
  failingSince: DateTimeTz
  lastSuccessAt: DateTimeTz
  circuitOpenUntil: DateTimeTz
  disabledAt: DateTimeTz
  disabledReason: String
  failureWarningSentAt: DateTimeTz
  pendingDeliveries: Int!
  createdAt: DateTimeTz!
  updatedAt: DateTimeTz!
  deletedAt: DateTimeTz
  logs(
    where: WebhookLogsWhereWhereConditions
    orderBy: [WebhookLogsOrderByOrderByClause!]
    first: Int!
    after: String
  ): WebhookLogConnection!
}

Fields​

Webhook.id ● ID! non-null scalar​

Webhook's unique identifier.

Webhook.name ● String scalar​

The webhook's name.

Webhook.description ● String scalar​

The webhook's description.

Webhook.url ● String scalar​

The webhook's url.

Webhook.secret ● String scalar​

The webhook's secret.

Webhook.isEnabled ● Boolean scalar​

Whether this webhook is enabled.

Webhook.events ● [WebhookEventSubscription!] list object​

The events this webhook receives. Null means every event, including resources added later. Event types are <resource>.<action>, the same type the delivered payload carries.

Webhook.consecutiveFailures ● Int! non-null scalar​

Number of delivery attempts that have failed in a row since the last successful one.

Webhook.failingSince ● DateTimeTz scalar​

When the current unbroken run of failures started. Null while the endpoint is healthy.

Webhook.lastSuccessAt ● DateTimeTz scalar​

The last time a delivery to this endpoint was accepted.

Webhook.circuitOpenUntil ● DateTimeTz scalar​

While set to a future time, deliveries are paused after repeated failures and will be retried automatically once it passes. Null while the endpoint is healthy.

Webhook.disabledAt ● DateTimeTz scalar​

When the webhook was automatically switched off after sustained failures.

Webhook.disabledReason ● String scalar​

Why the webhook was switched off, as a key the client translates.

Webhook.failureWarningSentAt ● DateTimeTz scalar​

When the account was warned that this endpoint was about to be switched off.

Webhook.pendingDeliveries ● Int! non-null scalar​

How many events are waiting for this endpoint, including one that may be in flight right now. Non-zero while deliveries are paused. Once the endpoint accepts a request again the backlog drains oldest-first, though newer events can be delivered ahead of it. Waiting events are discarded when the webhook is switched off or deleted, and a single event is dropped after repeated failures only while the endpoint keeps accepting others.

Webhook.createdAt ● DateTimeTz! non-null scalar​

The date and time when the webhook was created.

Webhook.updatedAt ● DateTimeTz! non-null scalar​

The date and time when the webhook was last updated.

Webhook.deletedAt ● DateTimeTz scalar​

The date and time when the webhook was deleted.

Webhook.logs ● WebhookLogConnection! non-null object​

The webhooks' logs.

Webhook.logs.where ● WebhookLogsWhereWhereConditions input​
Webhook.logs.orderBy ● [WebhookLogsOrderByOrderByClause!] list input​
Webhook.logs.first ● Int! non-null scalar​

Limits number of fetched items. Maximum allowed value: 50.

Webhook.logs.after ● String scalar​

A cursor after which elements are returned.

Returned By​

createWebhook mutation ● deleteWebhook mutation ● restoreWebhook mutation ● updateWebhook mutation ● webhook query

Member Of​

WebhookEdge object