Graphql API used to configure outbound webhooks
Required Headers
| Name | Value | Example |
|---|---|---|
| x-nacelle-space-id | The spaceID for the request | "x-nacelle-space-id": "a space id" |
| Authorization | An authorization token granting access to the space id | "Authorization": "Bearer ey...." |
Schema Types
Table of Contents
Query
| Field | Argument | Type | Description |
|---|---|---|---|
| fetchWebhookConfigs | [WebhookConfig] | Fetch a webhook configs. | |
| filter | WebhookFilter | The filter to apply when retrieving webhook configs. | |
Mutation
| Field | Argument | Type | Description |
|---|---|---|---|
| upsertWebhook | WebhookConfig! | Upsert a webhook config. If the ID is provided, the webhook will be updated. Otherwise, a new webhook will be created. | |
| config | UpsertWebhookConfig! | The webhook config to upsert. If the ID is provided, the webhook will be updated. Otherwise, a new webhook will be created. | |
| deleteWebhook | Boolean! | Delete a webhook config. | |
| id | UUID! | The ID of the webhook config to delete. | |
Objects
WebhookConfig
A webhook config.
| Field | Argument | Type | Description |
|---|---|---|---|
| id | UUID! | The ID of the webhook config. | |
| url | String! | The URL to send the webhook to. | |
| Secret | String! | The secret to use when sending the webhook. | |
| ModifiedAt | Time! | When the webhook config was last modified. | |
| CreatedAt | Time! | When the webhook config was created. | |
| CreatedBy | String! | 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.
WebhookFilter
The filter to apply when retrieving webhook configs.
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
