activateWebhookEndpointSecret

Promote the staged pending secret to active. Subsequent deliveries are signed with it.

Required scopes: webhooks_write

Arguments

id · ID! · required

Returns

activateWebhookEndpointSecret · WebhookEndpoint

A destination the merchant has registered to receive webhook deliveries. disabledAt is null while active.

Show fields

apiVersion · ApiVersion! · required

The API version this endpoint’s deliveries are shaped by.

createdAt · DateTime! · required

When the record was created.

description · String

An optional merchant-supplied label for the endpoint.

disabledAt · DateTime

When the endpoint was disabled, or null if active.

disabledReason · String

Why the endpoint was disabled, or null if active.

id · ID! · required

The id of this webhook endpoint.

pendingSecretCreatedAt · DateTime

When a pending (staged, not-yet-activated) secret was created, if any.

secretSetAt · DateTime! · required

When the current signing secret became active.

topics · [WebhookTopic!]! · required

Topics this endpoint is subscribed to.

updatedAt · DateTime! · required

When the record was last updated.

url · String! · required

The URL deliveries are POSTed to.

Example

mutation {
  activateWebhookEndpointSecret(id: "...") {
    apiVersion
    createdAt
    description
    disabledAt
    disabledReason
    id
    pendingSecretCreatedAt
    secretSetAt
    # ...
  }
}