WebhookCreateInput

Fields required to create a webhook.

input WebhookCreateInput {
  name: String
  targetUrl: String
  events: [WebhookEventTypeEnum!]
  app: ID
  isActive: Boolean
  secretKey: String
  connectionString: String
  queueName: String
}

Fields

WebhookCreateInput.name ● String scalar

The name of the webhook.

WebhookCreateInput.targetUrl ● String scalar

The url to receive the payload.

WebhookCreateInput.events ● [WebhookEventTypeEnum!] list enum

The events that webhook wants to subscribe (event type names).

WebhookCreateInput.app ● ID scalar

ID of the app to which webhook belongs. If not specified, a bearer token must be used and the webhook will be attached to the app the bearer token belongs to.

WebhookCreateInput.isActive ● Boolean scalar

Determine if webhook will be set active or not.

WebhookCreateInput.secretKey ● String scalar

The secret key used to create a hash signature with each payload.

WebhookCreateInput.connectionString ● String scalar

The connection string or service key json for third party queue services.

WebhookCreateInput.queueName ● String scalar

The queue name for Microsoft Azure ServiceBus connection.

Member Of

webhookCreate mutation