WebhookDefinition

public struct WebhookDefinition : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website. IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration. UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

    Declaration

    Swift

    public let authentication: WebhookAuthenticationType

  • Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

    Declaration

    Swift

    public let authenticationConfiguration: WebhookAuthConfiguration

  • A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

    Declaration

    Swift

    public let filters: [WebhookFilterRule]

  • The name of the webhook.

    Declaration

    Swift

    public let name: String

  • The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

    Declaration

    Swift

    public let targetAction: String

  • The name of the pipeline you want to connect to the webhook.

    Declaration

    Swift

    public let targetPipeline: String

  • Undocumented

    Declaration

    Swift

    public init(authentication: WebhookAuthenticationType, authenticationConfiguration: WebhookAuthConfiguration, filters: [WebhookFilterRule], name: String, targetAction: String, targetPipeline: String)

  • Declaration

    Swift

    public func validate(name: String) throws