Skip to main content

webhooksSetHeaders

Replaces the custom request headers sent with a rule's webhook deliveries.

Business Rules​

  • The rule must belong to the current company and have a Send Webhook action.
  • At most 10 headers; names use letters, digits, hyphens, and underscores, up to 64 characters.
  • Values are strings up to 512 characters and cannot contain control characters.
  • Reserved headers (X-EC-Signature, Content-Type, Host, Content-Length, Transfer-Encoding, Connection, Expect, Upgrade) cannot be set.
  • Header values are write-only: they are stored encrypted and never returned.

Error Scenarios​

  • Returns a not found error when the rule does not exist in the current company.
  • Returns a validation error for reserved or malformed header names.

Permissions Required​

  • webhooks:set_headers
webhooksSetHeaders(
  input: SetWebhookHeadersInput!
): Automation!

Arguments​

webhooksSetHeaders.input ● SetWebhookHeadersInput! non-null input common​

Parameters for SetWebhookHeaders

Type​

Automation object automations​

The automation rule type