Skip to main content

WebhookEndpoint

A registered webhook endpoint. Riverr POSTs a signed event payload to url whenever one of enabledEvents occurs for your enterprise, so you can react to changes in real time instead of polling the API.

type WebhookEndpoint {
  id: ID!
  url: String!
  enabledEvents: [WebhookEventType!]!
  description: String
  active: Boolean!
  createdAt: Timestamp
  updatedAt: Timestamp
  secret: String
}

Fields​

WebhookEndpoint.id ● ID! non-null scalar​

WebhookEndpoint.url ● String! non-null scalar​

The HTTPS URL events are delivered to.

WebhookEndpoint.enabledEvents ● [WebhookEventType!]! non-null enum​

Event types this endpoint receives.

WebhookEndpoint.description ● String scalar​

Optional human-readable label.

WebhookEndpoint.active ● Boolean! non-null scalar​

When false, delivery is paused without deleting the endpoint.

WebhookEndpoint.createdAt ● Timestamp object​

WebhookEndpoint.updatedAt ● Timestamp object​

WebhookEndpoint.secret ● String scalar​

The signing secret used to compute the Riverr-Signature header. Returned ONLY when the endpoint is created or its secret is rotated — store it securely, it is never returned again.

Returned By​

createWebhookEndpoint mutation ● rotateWebhookEndpointSecret mutation ● updateWebhookEndpoint mutation ● webhookEndpoint query ● webhookEndpoints query