EventToWebHookConfig
Event action configuration for webhook automation.
Defines automated HTTP POST requests to external endpoints when system events occur. Includes URL destination, authentication settings, and security configurations for reliable webhook delivery.
type EventToWebHookConfig implements IEventActionConfig {
id: String!
trigger: EventTrigger!
code: String
createdAt: DateTime!
lastModifiedAt: DateTime!
createdBy: Int
lastModifiedBy: Int
names(
language: String
): [LocalizedString!]!
url: String!
signatureSalt: String
basicAuthUsername: String
}
Fields
EventToWebHookConfig.id ● String! non-null scalar
Unique identifier for the event action configuration.
Uses UUID v7 format for chronological ordering and global uniqueness across the system.
EventToWebHookConfig.trigger ● EventTrigger! non-null enum
System event that activates this action configuration.
Defines which event type will cause this automation to execute, enabling event-driven workflow processing.
EventToWebHookConfig.code ● String scalar
Custom event identifier for CUSTOM_EVENT triggers.
Required when trigger type is CUSTOM_EVENT. Used to match and execute specific configurations when custom events are triggered.
EventToWebHookConfig.createdAt ● DateTime! non-null scalar
Timestamp when the event action configuration was initially created.
Provides audit trail information for tracking configuration lifecycle and changes.
EventToWebHookConfig.lastModifiedAt ● DateTime! non-null scalar
Timestamp when the event action configuration was last updated.
Provides audit trail information for tracking recent changes and configuration history.
EventToWebHookConfig.createdBy ● Int scalar
User identifier who created this event action configuration.
Provides audit trail information for tracking configuration ownership and accountability.
EventToWebHookConfig.lastModifiedBy ● Int scalar
User identifier who last modified this event action configuration.
Provides audit trail information for tracking recent changes and accountability.
EventToWebHookConfig.names ● [LocalizedString!]! non-null object
Localized display names for the event action configuration.
Provides human-readable names in multiple languages for user interface display and identification purposes.
EventToWebHookConfig.names.language ● String scalar
Language code filter for localized content.
Filters localized string results to return only entries matching the specified language code. When omitted, returns all available language variants.
EventToWebHookConfig.url ● String! non-null scalar
Target webhook endpoint for HTTP POST requests.
Must be a secure HTTPS URL where event payloads will be sent for external system integration and automation.
EventToWebHookConfig.signatureSalt ● String scalar
The salt used to generate HMAC-SHA256 signature for webhook authentication.
When configured, the webhook will include an 'X-Propeller-Signature' header with format 'sha256=<hex_signature>'.
To verify the signature:
- JSON stringify the payload
- Generate HMAC-SHA256 using this salt and the stringified payload
- Compare with the received signature using crypto.timingSafeEqual() to prevent timing attacks
Example (Node.js): const expectedSig = crypto.createHmac('sha256', salt).update(JSON.stringify(payload), 'utf8').digest('hex'); const receivedSig = signature.replace('sha256=', ''); return crypto.timingSafeEqual(Buffer.from(expectedSig, 'hex'), Buffer.from(receivedSig, 'hex'));
EventToWebHookConfig.basicAuthUsername ● String scalar
Username for HTTP Basic Authentication.
Used together with basicAuthPassword to provide authentication credentials for webhook requests. Both username and password must be provided or both omitted.
Interfaces
IEventActionConfig interface
Base interface for event action configurations.
Defines the common structure for all event action types including email and webhook configurations. Provides shared fields for identification, timing, and event triggering.
Returned By
eventToWebHookConfigCreate mutation ● eventToWebHookConfigUpdate mutation