Webhook Config Graphql API

Graphql API used to configure outbound webhooks

Required Headers

NameValueExample
x-nacelle-space-idThe spaceID for the request"x-nacelle-space-id": "a space id"
AuthorizationAn authorization token granting access to the space id"Authorization": "Bearer ey...."

Schema Types

Table of Contents

Query

FieldArgumentTypeDescription
fetchWebhookConfigs[WebhookConfig]

Fetch a webhook configs.

filterWebhookFilter

The filter to apply when retrieving webhook configs.

Mutation

FieldArgumentTypeDescription
upsertWebhookWebhookConfig!

Upsert a webhook config. If the ID is provided, the webhook will be updated. Otherwise, a new webhook will be created.

configUpsertWebhookConfig!

The webhook config to upsert. If the ID is provided, the webhook will be updated. Otherwise, a new webhook will be created.

deleteWebhookBoolean!

Delete a webhook config.

idUUID!

The ID of the webhook config to delete.

Objects

WebhookConfig

A webhook config.

FieldArgumentTypeDescription
idUUID!

The ID of the webhook config.

urlString!

The URL to send the webhook to.

SecretString!

The secret to use when sending the webhook.

ModifiedAtTime!

When the webhook config was last modified.

CreatedAtTime!

When the webhook config was created.

CreatedByString!

The user who created the webhook config.

Inputs

UpsertWebhookConfig

The webhook config to upsert. If the ID is provided, the webhook will be updated. Otherwise, a new webhook will be created.

FieldTypeDescription
idUUID

(Optional) The ID of the webhook config to update. If not provided, a new webhook config will be created.

urlString!

The URL to send the webhook to.

secretString!

The secret to use when sending the webhook.

createdByString!

The user who created the webhook config.

WebhookFilter

The filter to apply when retrieving webhook configs.

FieldTypeDescription
afterString

A base64 encoded cursor string to retrieve results after this cursor.

beforeString

A base64 encoded cursor string to retrieve results before this cursor.

Scalars

Boolean

The Boolean scalar type represents true or false.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Time

Represents a date and time according to ISO-8601

UUID

Represents a UUID according to RFC 4122