WebhookTarget

Object

Contains the input values needed to create a webhook target.

type WebhookTarget {
  batchedContentModeConfig: WebhookTargetCloudEventBatchedContentModeConfig
  contentMode: WebhookTargetCloudEventContentMode
  enabled: Boolean
  eventExtensions: GraphQLJSON
  eventFilters: WebhookTargetEventFilter
  httpTarget: WebhookTargetHTTPTarget
  id: String
  maxRetry: Long
  metadata: [WebhookTargetMetadataEntry]
  name: String
  organization: Org
  user: User
}

Fields

Field	Type	Description
batchedContentModeConfig	WebhookTargetCloudEventBatchedContentModeConfig
contentMode	WebhookTargetCloudEventContentMode
enabled	Boolean	True/False Boolean field used to enable or disable a webhook.
eventExtensions	GraphQLJSON
eventFilters	WebhookTargetEventFilter	Fields for eventFilters define what you data you want the webhook to send to your endpoint.
httpTarget	WebhookTargetHTTPTarget	Fields for httpTarget define the details of the endpoint where data will be sent.
id	String	The unique ID of the webhook.
maxRetry	Long	This defines how many times we will attempt to send a webhook payload before giving up if we don't get a 200 OK response.
metadata	[WebhookTargetMetadataEntry]
name	String	This is the unique name of the webhook; this should include details about the data being sent, to differentiate it from other webhooks.
organization	Org	The organization the webhook belongs to; this is automatically defined by the user creating the webhook.
user	User	The details of the user creating the webhook; this is also automatically defined during the webhook creation.

Used by

• WebhookTargetCreateResponse.target (field)
• webhookTargets (query)
• WebhookTargetUpdateResponse.target (field)