Skip to main content

EventDestination

A place outside Massdriver that receives the organization's audit log events.

Massdriver sends each event that matches the filter, one at a time, and retries failed sends with backoff. Order is not guaranteed. A receiver can drop duplicates by the event id.

type EventDestination {
id: ID!
name: String!
adapter: EventDestinationAdapter!
config: Map!
filter: EventFilter!
condition: String
status: EventDestinationStatus!
signingSecret: String
failingSince: DateTime
createdAt: DateTime!
updatedAt: DateTime!
deliveries(
filter: EventDeliveriesFilter
sort: EventDeliveriesSort
cursor: Cursor
): EventDeliveriesPage
}

Fields​

EventDestination.id ● ID! non-null scalar {#id}​

Unique identifier of the destination.

EventDestination.name ● String! non-null scalar {#name}​

Name of the destination, unique in the organization.

EventDestination.adapter ● EventDestinationAdapter! non-null enum {#adapter}​

How Massdriver sends events.

EventDestination.config ● Map! non-null scalar {#config}​

Where and how events are sent, in the shape of the adapter's configSchema. The destination's auth credentials are never returned.

EventDestination.filter ● EventFilter! non-null object {#filter}​

The events the destination receives.

EventDestination.condition ● String scalar {#condition}​

A jq expression run on each CloudEvent that the filter matches. The event is sent only when it outputs true. null sends every event the filter matches.

EventDestination.status ● EventDestinationStatus! non-null enum {#status}​

Whether the destination receives events.

EventDestination.signingSecret ● String scalar {#signing-secret}​

The secret that signs each request, in Standard Webhooks form (whsec_ followed by base64). Use it to check the webhook-signature header. Treat it as a credential. null for adapters that do not sign.

EventDestination.failingSince ● DateTime scalar {#failing-since}​

When sends to the destination started to fail. null when the last send succeeded.

EventDestination.createdAt ● DateTime! non-null scalar {#created-at}​

When the destination was added (UTC).

EventDestination.updatedAt ● DateTime! non-null scalar {#updated-at}​

When the destination last changed (UTC).

EventDestination.deliveries ● EventDeliveriesPage object {#deliveries}​

The events matched to this destination and the state of each send. Newest first by default.

EventDestination.deliveries.filter ● EventDeliveriesFilter input {#event-destination-deliveries-filter}​

Filter criteria. All filters are combined with AND.

EventDestination.deliveries.sort ● EventDeliveriesSort input {#event-destination-deliveries-sort}​

Sort order. Defaults to createdAt descending.

EventDestination.deliveries.cursor ● Cursor input {#event-destination-deliveries-cursor}​

Pagination cursor from a previous response.

Returned By​

eventDestination query

Member Of​

EventDestinationPayload object ● EventDestinationsPage object