GraphQL RepositorieswebhookEvent

`entities.webhookEvent`

Read webhook event records with the webhookEvent repository, and change them with the webhook event mutations. Same records as the REST WebhookEvents entity.

Example: first three webhook event recordsGraphQLcURL

query FirstWebhookEvents {
  entities {
    webhookEvent {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstWebhookEvents { entities { webhookEvent { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { webhookEvent { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	WebhookEventEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[WebhookEventEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: WebhookEventFilterInput, orderBy: [WebhookEventOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[WebhookEventEntity!]!
QUERY	`getByCriteria`(filter: WebhookEventFilterInput, orderBy: [WebhookEventOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	WebhookEventEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createWebhookEvent`(input: CreateWebhookEventInput!, validationLevel: [ValidationLevel!])	Create one record	CreateWebhookEventPayload
MUTATION	`updateWebhookEvent`(input: UpdateWebhookEventInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateWebhookEventPayload
MUTATION	`bulkUpdateWebhookEvent`(input: [CreateOrUpdateWebhookEventInput!]!, deleteInput: [DeleteWebhookEventInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateWebhookEventPayload
MUTATION	`deleteWebhookEvent`(input: DeleteWebhookEventInput!)	Soft-delete	DeleteWebhookEventPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

WebhookEventEntity object 9 fields: isDeleteProtected, id, isDeleted, …

Event a webhook subscribes to; the webhook is called whenever the event occurs.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`webhook`	WebhookEntity	Webhook this subscription belongs to. The parent webhook is fired whenever the subscribed event occurs.
`event`	EventEnum!	Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space.
`webhookId`	ID!	Id of the parent webhook.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

WebhookEventEntityConnection object pageInfo: PageInfo!, edges: [WebhookEventEntityEdge]!, totalCount: Int

Paginated list of WebhookEvent records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[WebhookEventEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

WebhookEventEntityEdge object node: WebhookEventEntity, cursor: String!

A Relay edge containing a WebhookEventEntity and its cursor.

Field	Type	Description
`node`	WebhookEventEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

WebhookEventFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for WebhookEvent records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[WebhookEventFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[WebhookEventFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	WebhookEventFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`event`	EntityFilterStringField	Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space.
`webhookId`	EntityFilterStringField	Id of the parent webhook.
`webhook`	WebhookFilterInput	Webhook this subscription belongs to. The parent webhook is fired whenever the subscribed event occurs. Matches records where a related record meets these conditions.

WebhookEventOrderByInput input Asc or Desc per field

Sorting of WebhookEvent records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`webhook`	[WebhookOrderByNestedInput!]	Webhook this subscription belongs to. The parent webhook is fired whenever the subscribed event occurs. Sorts by fields of the related record, listed in order of priority.
`event`	OrderByEnum	Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space.
`webhookId`	OrderByEnum	Id of the parent webhook.

CreateOrUpdateWebhookEventInput input 6 fields: clientMutationId, id, modified, …

Field values of a WebhookEvent record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`event`	EventEnum	Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space.
`webhookId`	ID	Id of the parent webhook.

CreateWebhookEventInput input 5 fields: clientMutationId, modified, created, …

Field values of a new WebhookEvent record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`event`	EventEnum!	Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space.
`webhookId`	ID!	Id of the parent webhook.

DeleteWebhookEventInput input clientMutationId: String, id: ID!

Id of the WebhookEvent record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateWebhookEventInput input 6 fields: clientMutationId, id, modified, …

Id of a WebhookEvent record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`event`	EventEnum	Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space.
`webhookId`	ID	Id of the parent webhook.

WebhookOrderByNestedInput input 8 fields: id, isDeleted, modified, …

Sorting by a field of the related Webhook record. Set exactly one field in each item.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`applicationId`	OrderByEnum	Id of the OAuth application that registered the Webhook.
`clientId`	OrderByEnum	Id of the user who defined the Webhook.
`insecureSsl`	OrderByEnum	If True, remote side ssl certificate will not be validated when delivering notifications.
`url`	OrderByEnum	Target URL that webhook event payloads are POSTed to.

BulkUpdateWebhookEventPayload object result: BulkUpdateResults!

Result of the bulkUpdateWebhookEvent mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateWebhookEventPayload object webhookEvent: WebhookEventEntity, clientMutationId: String

Result of the createWebhookEvent mutation.

Field	Type	Description
`webhookEvent`	WebhookEventEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteWebhookEventPayload object webhookEvent: WebhookEventEntity, clientMutationId: String

Result of the deleteWebhookEvent mutation.

Field	Type	Description
`webhookEvent`	WebhookEventEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateWebhookEventPayload object webhookEvent: WebhookEventEntity, clientMutationId: String

Result of the updateWebhookEvent mutation.

Field	Type	Description
`webhookEvent`	WebhookEventEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).