Skip to main content

EventToWebHookConfigUpdateInput

No description

input EventToWebHookConfigUpdateInput {
  names: [LocalizedStringInput!]
  trigger: EventTrigger
  code: String
  url: String
  signatureSalt: String
  basicAuthUsername: String
  basicAuthPassword: String
}

Fields​

EventToWebHookConfigUpdateInput.names ● [LocalizedStringInput!] list input​

The display names for the event per language

EventToWebHookConfigUpdateInput.trigger ● EventTrigger enum​

The event to trigger the action defined in the event action config

EventToWebHookConfigUpdateInput.code ● String scalar​

The event code to use when the trigger is [CUSTOM_EVENT]

EventToWebHookConfigUpdateInput.url ● String scalar​

The URL of the webhook to send the payload to

EventToWebHookConfigUpdateInput.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:

  1. JSON stringify the payload
  2. Generate HMAC-SHA256 using this salt and the stringified payload
  3. 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'));

EventToWebHookConfigUpdateInput.basicAuthUsername ● String scalar​

The username for basic HTTP authentication

EventToWebHookConfigUpdateInput.basicAuthPassword ● String scalar​

The password for basic HTTP authentication

Member Of​

eventToWebHookConfigUpdate mutation