CreateWebhookEndpointRequest

Request body for creating a public webhook endpoint.

  • auth
    required

    Outbound auth configuration used when Augment delivers webhooks to your endpoint. This is not the same as the API key auth used to call Augment.

    Bearer token authentication for webhook delivery requests.

    • type
      Discriminator
      enum
      const:  
      bearerToken
      required

      Bearer token auth.

      values
      • bearerToken
    • token
      Type: string
      required

      Secret token sent as Authorization: Bearer <token> on webhook delivery. This token is never returned by read or list responses.

  • url
    Type: string Format: uri
    required

    HTTPS URL that receives Augment webhook deliveries

  • customHeaders
    Type: object · WebhookCustomHeadersnullable

    Optional custom headers sent with webhook deliveries

    Custom headers sent with webhook deliveries.

    • propertyName
      Type: string
  • name
    Type: string

    Optional display name for the endpoint