@vercel/sdk/esm/models/createwebhookop.d.ts

<p align="center"> <a href="https://vercel.com"> <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96"> <h3 align="center">Vercel</h3> </a> <p align="center">Develop. Preview. Ship.</p> </p>

import * as z from "zod/v3";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
export declare const Events: {
    readonly BudgetReached: "budget.reached";
    readonly DomainCreated: "domain.created";
    readonly DomainDnsRecordsChanged: "domain.dns.records.changed";
    readonly DomainTransferInStarted: "domain.transfer-in.started";
    readonly DomainTransferInCompleted: "domain.transfer-in.completed";
    readonly DomainTransferInFailed: "domain.transfer-in.failed";
    readonly DomainCertificateAdd: "domain.certificate.add";
    readonly DomainCertificateAddFailed: "domain.certificate.add.failed";
    readonly DomainCertificateRenew: "domain.certificate.renew";
    readonly DomainCertificateRenewFailed: "domain.certificate.renew.failed";
    readonly DomainCertificateDeleted: "domain.certificate.deleted";
    readonly DomainRenewal: "domain.renewal";
    readonly DomainRenewalFailed: "domain.renewal.failed";
    readonly DomainAutoRenewChanged: "domain.auto-renew.changed";
    readonly DeploymentCreated: "deployment.created";
    readonly DeploymentBuildRequested: "deployment.build-requested";
    readonly DeploymentCleanup: "deployment.cleanup";
    readonly DeploymentError: "deployment.error";
    readonly DeploymentBlocked: "deployment.blocked";
    readonly DeploymentCanceled: "deployment.canceled";
    readonly DeploymentSucceeded: "deployment.succeeded";
    readonly DeploymentReady: "deployment.ready";
    readonly DeploymentCheckRerequested: "deployment.check-rerequested";
    readonly DeploymentPromoted: "deployment.promoted";
    readonly DeploymentRollback: "deployment.rollback";
    readonly DeploymentIntegrationActionStart: "deployment.integration.action.start";
    readonly DeploymentIntegrationActionCancel: "deployment.integration.action.cancel";
    readonly DeploymentIntegrationActionCleanup: "deployment.integration.action.cleanup";
    readonly DeploymentCheckrunStart: "deployment.checkrun.start";
    readonly DeploymentCheckrunCancel: "deployment.checkrun.cancel";
    readonly EdgeConfigCreated: "edge-config.created";
    readonly EdgeConfigDeleted: "edge-config.deleted";
    readonly EdgeConfigItemsUpdated: "edge-config.items.updated";
    readonly FirewallAttack: "firewall.attack";
    readonly FirewallSystemRuleAnomaly: "firewall.system-rule-anomaly";
    readonly FirewallCustomRuleAnomaly: "firewall.custom-rule-anomaly";
    readonly FunctionArchivalRequired: "function.archival-required";
    readonly FunctionRemovalRequired: "function.removal-required";
    readonly AlertsTriggered: "alerts.triggered";
    readonly IntegrationConfigurationPermissionUpgraded: "integration-configuration.permission-upgraded";
    readonly IntegrationConfigurationRemoved: "integration-configuration.removed";
    readonly IntegrationConfigurationScopeChangeConfirmed: "integration-configuration.scope-change-confirmed";
    readonly IntegrationConfigurationTransferred: "integration-configuration.transferred";
    readonly IntegrationResourceProjectConnected: "integration-resource.project-connected";
    readonly IntegrationResourceProjectDisconnected: "integration-resource.project-disconnected";
    readonly ProjectCreated: "project.created";
    readonly ProjectRemoved: "project.removed";
    readonly ProjectRenamed: "project.renamed";
    readonly ProjectEnvVariableCreated: "project.env-variable.created";
    readonly ProjectEnvVariableUpdated: "project.env-variable.updated";
    readonly ProjectEnvVariableDeleted: "project.env-variable.deleted";
    readonly ProjectDomainCreated: "project.domain.created";
    readonly ProjectDomainUpdated: "project.domain.updated";
    readonly ProjectDomainDeleted: "project.domain.deleted";
    readonly ProjectDomainVerified: "project.domain.verified";
    readonly ProjectDomainUnverified: "project.domain.unverified";
    readonly ProjectDomainMoved: "project.domain.moved";
    readonly ProjectRollingReleaseStarted: "project.rolling-release.started";
    readonly ProjectRollingReleaseAborted: "project.rolling-release.aborted";
    readonly ProjectRollingReleaseCompleted: "project.rolling-release.completed";
    readonly ProjectRollingReleaseApproved: "project.rolling-release.approved";
    readonly DeploymentChecksFailed: "deployment.checks.failed";
    readonly DeploymentChecksSucceeded: "deployment.checks.succeeded";
    readonly DeploymentChecksCompleted: "deployment-checks-completed";
    readonly DeploymentReadyHyphen: "deployment-ready";
    readonly DeploymentPreparedHyphen: "deployment-prepared";
    readonly DeploymentErrorHyphen: "deployment-error";
    readonly DeploymentCheckRerequestedHyphen: "deployment-check-rerequested";
    readonly DeploymentCanceledHyphen: "deployment-canceled";
    readonly ProjectCreatedHyphen: "project-created";
    readonly ProjectRemovedHyphen: "project-removed";
    readonly DomainCreatedHyphen: "domain-created";
    readonly Deployment: "deployment";
    readonly IntegrationConfigurationPermissionUpdatedHyphen: "integration-configuration-permission-updated";
    readonly IntegrationConfigurationRemovedHyphen: "integration-configuration-removed";
    readonly IntegrationConfigurationScopeChangeConfirmedHyphen: "integration-configuration-scope-change-confirmed";
    readonly MarketplaceMemberChanged: "marketplace.member.changed";
    readonly MarketplaceInvoiceCreated: "marketplace.invoice.created";
    readonly MarketplaceInvoicePaid: "marketplace.invoice.paid";
    readonly MarketplaceInvoiceNotpaid: "marketplace.invoice.notpaid";
    readonly MarketplaceInvoiceOverdue: "marketplace.invoice.overdue";
    readonly MarketplaceInvoiceRefunded: "marketplace.invoice.refunded";
    readonly AiGatewayBalanceDepleted: "ai-gateway.balance-depleted";
    readonly AiGatewayAutoReloadLimitReached: "ai-gateway.auto-reload.limit-reached";
    readonly ObservabilityAnomaly: "observability.anomaly";
    readonly ObservabilityAnomalyError: "observability.anomaly-error";
    readonly ObservabilityUsageAnomaly: "observability.usage-anomaly";
    readonly ObservabilityErrorAnomaly: "observability.error-anomaly";
    readonly BotidAnomaly: "botid.anomaly";
    readonly FlagCreated: "flag.created";
    readonly FlagUpdated: "flag.updated";
    readonly FlagDeleted: "flag.deleted";
    readonly FlagSegmentCreated: "flag.segment.created";
    readonly FlagSegmentUpdated: "flag.segment.updated";
    readonly FlagSegmentDeleted: "flag.segment.deleted";
    readonly TestWebhook: "test-webhook";
    readonly MessageCreated: "message.created";
    readonly MessageUpdated: "message.updated";
    readonly MessageDeleted: "message.deleted";
    readonly ThreadResolved: "thread.resolved";
    readonly ThreadUnresolved: "thread.unresolved";
    readonly MessageReactionAdded: "message.reaction-added";
    readonly MessageReactionRemoved: "message.reaction-removed";
    readonly MessageMentioned: "message.mentioned";
    readonly CommentCreated: "comment.created";
    readonly CommentUpdated: "comment.updated";
    readonly CommentDeleted: "comment.deleted";
    readonly CommentResolved: "comment.resolved";
    readonly CommentUnresolved: "comment.unresolved";
    readonly CommentReactionAdded: "comment.reaction-added";
    readonly CommentReactionRemoved: "comment.reaction-removed";
    readonly CommentMentioned: "comment.mentioned";
};
export type Events = ClosedEnum<typeof Events>;
export type CreateWebhookRequestBody = {
    url: string;
    events: Array<Events>;
    projectIds?: Array<string> | undefined;
};
export type CreateWebhookRequest = {
    /**
     * The Team identifier to perform the request on behalf of.
     */
    teamId?: string | undefined;
    /**
     * The Team slug to perform the request on behalf of.
     */
    slug?: string | undefined;
    requestBody: CreateWebhookRequestBody;
};
/**
 * The webhooks events
 */
export declare const CreateWebhookEvents: {
    readonly AiGatewayAutoReloadLimitReached: "ai-gateway.auto-reload.limit-reached";
    readonly AiGatewayBalanceDepleted: "ai-gateway.balance-depleted";
    readonly AlertsTriggered: "alerts.triggered";
    readonly BotidAnomaly: "botid.anomaly";
    readonly BudgetReached: "budget.reached";
    readonly CommentCreated: "comment.created";
    readonly CommentDeleted: "comment.deleted";
    readonly CommentMentioned: "comment.mentioned";
    readonly CommentReactionAdded: "comment.reaction-added";
    readonly CommentReactionRemoved: "comment.reaction-removed";
    readonly CommentResolved: "comment.resolved";
    readonly CommentUnresolved: "comment.unresolved";
    readonly CommentUpdated: "comment.updated";
    readonly Deployment: "deployment";
    readonly DeploymentCanceledHyphen: "deployment-canceled";
    readonly DeploymentCheckRerequestedHyphen: "deployment-check-rerequested";
    readonly DeploymentChecksCompleted: "deployment-checks-completed";
    readonly DeploymentErrorHyphen: "deployment-error";
    readonly DeploymentPreparedHyphen: "deployment-prepared";
    readonly DeploymentReadyHyphen: "deployment-ready";
    readonly DeploymentBlocked: "deployment.blocked";
    readonly DeploymentBuildRequested: "deployment.build-requested";
    readonly DeploymentCanceled: "deployment.canceled";
    readonly DeploymentCheckRerequested: "deployment.check-rerequested";
    readonly DeploymentCheckrunCancel: "deployment.checkrun.cancel";
    readonly DeploymentCheckrunStart: "deployment.checkrun.start";
    readonly DeploymentChecksFailed: "deployment.checks.failed";
    readonly DeploymentChecksSucceeded: "deployment.checks.succeeded";
    readonly DeploymentCleanup: "deployment.cleanup";
    readonly DeploymentCreated: "deployment.created";
    readonly DeploymentError: "deployment.error";
    readonly DeploymentIntegrationActionCancel: "deployment.integration.action.cancel";
    readonly DeploymentIntegrationActionCleanup: "deployment.integration.action.cleanup";
    readonly DeploymentIntegrationActionStart: "deployment.integration.action.start";
    readonly DeploymentPromoted: "deployment.promoted";
    readonly DeploymentReady: "deployment.ready";
    readonly DeploymentRollback: "deployment.rollback";
    readonly DeploymentSucceeded: "deployment.succeeded";
    readonly DomainCreatedHyphen: "domain-created";
    readonly DomainAutoRenewChanged: "domain.auto-renew.changed";
    readonly DomainCertificateAdd: "domain.certificate.add";
    readonly DomainCertificateAddFailed: "domain.certificate.add.failed";
    readonly DomainCertificateDeleted: "domain.certificate.deleted";
    readonly DomainCertificateRenew: "domain.certificate.renew";
    readonly DomainCertificateRenewFailed: "domain.certificate.renew.failed";
    readonly DomainCreated: "domain.created";
    readonly DomainDnsRecordsChanged: "domain.dns.records.changed";
    readonly DomainRenewal: "domain.renewal";
    readonly DomainRenewalFailed: "domain.renewal.failed";
    readonly DomainTransferInCompleted: "domain.transfer-in.completed";
    readonly DomainTransferInFailed: "domain.transfer-in.failed";
    readonly DomainTransferInStarted: "domain.transfer-in.started";
    readonly EdgeConfigCreated: "edge-config.created";
    readonly EdgeConfigDeleted: "edge-config.deleted";
    readonly EdgeConfigItemsUpdated: "edge-config.items.updated";
    readonly FirewallAttack: "firewall.attack";
    readonly FirewallCustomRuleAnomaly: "firewall.custom-rule-anomaly";
    readonly FirewallSystemRuleAnomaly: "firewall.system-rule-anomaly";
    readonly FlagCreated: "flag.created";
    readonly FlagDeleted: "flag.deleted";
    readonly FlagSegmentCreated: "flag.segment.created";
    readonly FlagSegmentDeleted: "flag.segment.deleted";
    readonly FlagSegmentUpdated: "flag.segment.updated";
    readonly FlagUpdated: "flag.updated";
    readonly FunctionArchivalRequired: "function.archival-required";
    readonly FunctionRemovalRequired: "function.removal-required";
    readonly IntegrationConfigurationPermissionUpdatedHyphen: "integration-configuration-permission-updated";
    readonly IntegrationConfigurationRemovedHyphen: "integration-configuration-removed";
    readonly IntegrationConfigurationScopeChangeConfirmedHyphen: "integration-configuration-scope-change-confirmed";
    readonly IntegrationConfigurationPermissionUpgraded: "integration-configuration.permission-upgraded";
    readonly IntegrationConfigurationRemoved: "integration-configuration.removed";
    readonly IntegrationConfigurationScopeChangeConfirmed: "integration-configuration.scope-change-confirmed";
    readonly IntegrationConfigurationTransferred: "integration-configuration.transferred";
    readonly IntegrationResourceProjectConnected: "integration-resource.project-connected";
    readonly IntegrationResourceProjectDisconnected: "integration-resource.project-disconnected";
    readonly MarketplaceInvoiceCreated: "marketplace.invoice.created";
    readonly MarketplaceInvoiceNotpaid: "marketplace.invoice.notpaid";
    readonly MarketplaceInvoiceOverdue: "marketplace.invoice.overdue";
    readonly MarketplaceInvoicePaid: "marketplace.invoice.paid";
    readonly MarketplaceInvoiceRefunded: "marketplace.invoice.refunded";
    readonly MarketplaceMemberChanged: "marketplace.member.changed";
    readonly MessageCreated: "message.created";
    readonly MessageDeleted: "message.deleted";
    readonly MessageMentioned: "message.mentioned";
    readonly MessageReactionAdded: "message.reaction-added";
    readonly MessageReactionRemoved: "message.reaction-removed";
    readonly MessageUpdated: "message.updated";
    readonly ObservabilityAnomaly: "observability.anomaly";
    readonly ObservabilityAnomalyError: "observability.anomaly-error";
    readonly ObservabilityErrorAnomaly: "observability.error-anomaly";
    readonly ObservabilityUsageAnomaly: "observability.usage-anomaly";
    readonly ProjectCreatedHyphen: "project-created";
    readonly ProjectRemovedHyphen: "project-removed";
    readonly ProjectCreated: "project.created";
    readonly ProjectDomainCreated: "project.domain.created";
    readonly ProjectDomainDeleted: "project.domain.deleted";
    readonly ProjectDomainMoved: "project.domain.moved";
    readonly ProjectDomainUnverified: "project.domain.unverified";
    readonly ProjectDomainUpdated: "project.domain.updated";
    readonly ProjectDomainVerified: "project.domain.verified";
    readonly ProjectEnvVariableCreated: "project.env-variable.created";
    readonly ProjectEnvVariableDeleted: "project.env-variable.deleted";
    readonly ProjectEnvVariableUpdated: "project.env-variable.updated";
    readonly ProjectRemoved: "project.removed";
    readonly ProjectRenamed: "project.renamed";
    readonly ProjectRollingReleaseAborted: "project.rolling-release.aborted";
    readonly ProjectRollingReleaseApproved: "project.rolling-release.approved";
    readonly ProjectRollingReleaseCompleted: "project.rolling-release.completed";
    readonly ProjectRollingReleaseStarted: "project.rolling-release.started";
    readonly TestWebhook: "test-webhook";
    readonly ThreadResolved: "thread.resolved";
    readonly ThreadUnresolved: "thread.unresolved";
};
/**
 * The webhooks events
 */
export type CreateWebhookEvents = ClosedEnum<typeof CreateWebhookEvents>;
export type CreateWebhookResponseBody = {
    /**
     * The webhook secret used to sign the payload
     */
    secret: string;
    /**
     * The webhooks events
     */
    events: Array<CreateWebhookEvents>;
    /**
     * The webhook id
     */
    id: string;
    /**
     * A string with the URL of the webhook
     */
    url: string;
    /**
     * The unique ID of the team the webhook belongs to
     */
    ownerId: string;
    /**
     * A number containing the date when the webhook was created in in milliseconds
     */
    createdAt: number;
    /**
     * A number containing the date when the webhook was updated in in milliseconds
     */
    updatedAt: number;
    /**
     * The ID of the projects the webhook is associated with
     */
    projectIds?: Array<string> | undefined;
};
/** @internal */
export declare const Events$outboundSchema: z.ZodNativeEnum<typeof Events>;
/** @internal */
export type CreateWebhookRequestBody$Outbound = {
    url: string;
    events: Array<string>;
    projectIds?: Array<string> | undefined;
};
/** @internal */
export declare const CreateWebhookRequestBody$outboundSchema: z.ZodType<CreateWebhookRequestBody$Outbound, z.ZodTypeDef, CreateWebhookRequestBody>;
export declare function createWebhookRequestBodyToJSON(createWebhookRequestBody: CreateWebhookRequestBody): string;
/** @internal */
export type CreateWebhookRequest$Outbound = {
    teamId?: string | undefined;
    slug?: string | undefined;
    RequestBody: CreateWebhookRequestBody$Outbound;
};
/** @internal */
export declare const CreateWebhookRequest$outboundSchema: z.ZodType<CreateWebhookRequest$Outbound, z.ZodTypeDef, CreateWebhookRequest>;
export declare function createWebhookRequestToJSON(createWebhookRequest: CreateWebhookRequest): string;
/** @internal */
export declare const CreateWebhookEvents$inboundSchema: z.ZodNativeEnum<typeof CreateWebhookEvents>;
/** @internal */
export declare const CreateWebhookResponseBody$inboundSchema: z.ZodType<CreateWebhookResponseBody, z.ZodTypeDef, unknown>;
export declare function createWebhookResponseBodyFromJSON(jsonString: string): SafeParseResult<CreateWebhookResponseBody, SDKValidationError>;
//# sourceMappingURL=createwebhookop.d.ts.map