models

package

v1.69.0Latest Latest

This package is not in the latest version of its module.

Go to latest Published: Jul 7, 2025 License:MITImports:5Imported by:0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/svix/svix-webhooks

Documentation ¶

Overview¶

Package svix this file is @generated DO NOT EDIT

Package svix this file was hand written¶

Package svix this file is @generated DO NOT EDIT

Index¶

Constants¶

This section is empty.

Variables¶

View Source

var BackgroundTaskStatusFromString = map[string]BackgroundTaskStatus{"running":BACKGROUNDTASKSTATUS_RUNNING,"finished":BACKGROUNDTASKSTATUS_FINISHED,"failed":BACKGROUNDTASKSTATUS_FAILED,}

View Source

var BackgroundTaskTypeFromString = map[string]BackgroundTaskType{"endpoint.replay":BACKGROUNDTASKTYPE_ENDPOINT_REPLAY,"endpoint.recover":BACKGROUNDTASKTYPE_ENDPOINT_RECOVER,"application.stats":BACKGROUNDTASKTYPE_APPLICATION_STATS,"message.broadcast":BACKGROUNDTASKTYPE_MESSAGE_BROADCAST,"sdk.generate":BACKGROUNDTASKTYPE_SDK_GENERATE,"event-type.aggregate":BACKGROUNDTASKTYPE_EVENT_TYPE_AGGREGATE,"application.purge_content":BACKGROUNDTASKTYPE_APPLICATION_PURGE_CONTENT,}

View Source

var BorderRadiusEnumFromString = map[string]BorderRadiusEnum{"none":BORDERRADIUSENUM_NONE,"lg":BORDERRADIUSENUM_LG,"md":BORDERRADIUSENUM_MD,"sm":BORDERRADIUSENUM_SM,"full":BORDERRADIUSENUM_FULL,}

View Source

var ConnectorKindFromString = map[string]ConnectorKind{"Custom":CONNECTORKIND_CUSTOM,"CloseCRM":CONNECTORKIND_CLOSE_CRM,"CustomerIO":CONNECTORKIND_CUSTOMER_IO,"Discord":CONNECTORKIND_DISCORD,"Hubspot":CONNECTORKIND_HUBSPOT,"Inngest":CONNECTORKIND_INNGEST,"Loops":CONNECTORKIND_LOOPS,"Resend":CONNECTORKIND_RESEND,"Salesforce":CONNECTORKIND_SALESFORCE,"Segment":CONNECTORKIND_SEGMENT,"Sendgrid":CONNECTORKIND_SENDGRID,"Slack":CONNECTORKIND_SLACK,"Teams":CONNECTORKIND_TEAMS,"TriggerDev":CONNECTORKIND_TRIGGER_DEV,"Windmill":CONNECTORKIND_WINDMILL,"Zapier":CONNECTORKIND_ZAPIER,}

View Source

var EndpointDisabledTriggerFromString = map[string]EndpointDisabledTrigger{"manual":ENDPOINTDISABLEDTRIGGER_MANUAL,"automatic":ENDPOINTDISABLEDTRIGGER_AUTOMATIC,}

View Source

var EnvironmentRegionFromString = map[string]EnvironmentRegion{"eu":ENVIRONMENTREGION_EU,"us":ENVIRONMENTREGION_US,"in":ENVIRONMENTREGION_IN,"au":ENVIRONMENTREGION_AU,"ca":ENVIRONMENTREGION_CA,"self-hosted":ENVIRONMENTREGION_SELF_HOSTED,}

View Source

var EnvironmentTypeFromString = map[string]EnvironmentType{"development":ENVIRONMENTTYPE_DEVELOPMENT,"production":ENVIRONMENTTYPE_PRODUCTION,}

View Source

var IngestSourceInTypeFromString = map[string]IngestSourceInType{"generic-webhook":IngestSourceInTypeGenericWebhook,"cron":IngestSourceInTypeCron,"adobe-sign":IngestSourceInTypeAdobeSign,"beehiiv":IngestSourceInTypeBeehiiv,"brex":IngestSourceInTypeBrex,"clerk":IngestSourceInTypeClerk,"docusign":IngestSourceInTypeDocusign,"github":IngestSourceInTypeGithub,"guesty":IngestSourceInTypeGuesty,"hubspot":IngestSourceInTypeHubspot,"incident-io":IngestSourceInTypeIncidentIo,"lithic":IngestSourceInTypeLithic,"nash":IngestSourceInTypeNash,"panda-doc":IngestSourceInTypePandaDoc,"pleo":IngestSourceInTypePleo,"replicate":IngestSourceInTypeReplicate,"resend":IngestSourceInTypeResend,"safebase":IngestSourceInTypeSafebase,"sardine":IngestSourceInTypeSardine,"segment":IngestSourceInTypeSegment,"shopify":IngestSourceInTypeShopify,"slack":IngestSourceInTypeSlack,"stripe":IngestSourceInTypeStripe,"stych":IngestSourceInTypeStych,"svix":IngestSourceInTypeSvix,"zoom":IngestSourceInTypeZoom,}

View Source

var IngestSourceInTypeWithNoConfig = map[string]bool{"generic-webhook":true,}

View Source

var IngestSourceOutTypeFromString = map[string]IngestSourceOutType{"generic-webhook":IngestSourceOutTypeGenericWebhook,"cron":IngestSourceOutTypeCron,"adobe-sign":IngestSourceOutTypeAdobeSign,"beehiiv":IngestSourceOutTypeBeehiiv,"brex":IngestSourceOutTypeBrex,"clerk":IngestSourceOutTypeClerk,"docusign":IngestSourceOutTypeDocusign,"github":IngestSourceOutTypeGithub,"guesty":IngestSourceOutTypeGuesty,"hubspot":IngestSourceOutTypeHubspot,"incident-io":IngestSourceOutTypeIncidentIo,"lithic":IngestSourceOutTypeLithic,"nash":IngestSourceOutTypeNash,"panda-doc":IngestSourceOutTypePandaDoc,"pleo":IngestSourceOutTypePleo,"replicate":IngestSourceOutTypeReplicate,"resend":IngestSourceOutTypeResend,"safebase":IngestSourceOutTypeSafebase,"sardine":IngestSourceOutTypeSardine,"segment":IngestSourceOutTypeSegment,"shopify":IngestSourceOutTypeShopify,"slack":IngestSourceOutTypeSlack,"stripe":IngestSourceOutTypeStripe,"stych":IngestSourceOutTypeStych,"svix":IngestSourceOutTypeSvix,"zoom":IngestSourceOutTypeZoom,}

View Source

var IngestSourceOutTypeWithNoConfig = map[string]bool{"generic-webhook":true,}

View Source

var MessageAttemptTriggerTypeFromInt64 = map[int64]MessageAttemptTriggerType{0:MESSAGEATTEMPTTRIGGERTYPE_SCHEDULED,1:MESSAGEATTEMPTTRIGGERTYPE_MANUAL,}

View Source

var MessageStatusFromInt64 = map[int64]MessageStatus{0:MESSAGESTATUS_SUCCESS,1:MESSAGESTATUS_PENDING,2:MESSAGESTATUS_FAIL,3:MESSAGESTATUS_SENDING,}

View Source

var OrderingFromString = map[string]Ordering{"ascending":ORDERING_ASCENDING,"descending":ORDERING_DESCENDING,}

View Source

var StatusCodeClassFromInt64 = map[int64]StatusCodeClass{0:STATUSCODECLASS_CODE_NONE,100:STATUSCODECLASS_CODE1XX,200:STATUSCODECLASS_CODE2XX,300:STATUSCODECLASS_CODE3XX,400:STATUSCODECLASS_CODE4XX,500:STATUSCODECLASS_CODE5XX,}

Functions¶

This section is empty.

Types¶

typeAdobeSignConfig ¶added inv1.63.0

type AdobeSignConfig struct {ClientIdstring `json:"clientId"`}

typeAdobeSignConfigOut ¶added inv1.63.0

type AdobeSignConfigOut struct {}

typeAggregateEventTypesOut ¶

type AggregateEventTypesOut struct {Idstring               `json:"id"`// The QueueBackgroundTask's ID.StatusBackgroundTaskStatus `json:"status"`TaskBackgroundTaskType   `json:"task"`}

typeApiTokenCensoredOut ¶added inv1.63.1

type ApiTokenCensoredOut struct {CensoredTokenstring     `json:"censoredToken"`CreatedAttime.Time  `json:"createdAt"`ExpiresAt     *time.Time `json:"expiresAt,omitempty"`Idstring     `json:"id"`// The ApplicationToken's ID.Name          *string    `json:"name,omitempty"`Scopes        []string   `json:"scopes,omitempty"`}

typeApiTokenExpireIn ¶added inv1.63.1

type ApiTokenExpireIn struct {Expiry *int32 `json:"expiry,omitempty"`// How many seconds until the old key is expired.}

typeApiTokenIn ¶added inv1.63.1

type ApiTokenIn struct {Namestring   `json:"name"`Scopes []string `json:"scopes,omitempty"`}

typeApiTokenOut ¶added inv1.63.1

type ApiTokenOut struct {CreatedAttime.Time  `json:"createdAt"`ExpiresAt *time.Time `json:"expiresAt,omitempty"`Idstring     `json:"id"`// The GlobalApplicationToken's ID.Name      *string    `json:"name,omitempty"`Scopes    []string   `json:"scopes,omitempty"`Tokenstring     `json:"token"`}

typeAppPortalAccessIn ¶

type AppPortalAccessIn struct {// Optionally creates a new application while generating the access link.//// If the application id or uid that is used in the path already exists, this argument is ignored.Application *ApplicationIn `json:"application,omitempty"`// How long the token will be valid for, in seconds.//// Valid values are between 1 hour and 7 days. The default is 7 days.Expiry       *uint64  `json:"expiry,omitempty"`FeatureFlags []string `json:"featureFlags,omitempty"`// The set of feature flags the created token will have access to.ReadOnly     *bool    `json:"readOnly,omitempty"`// Whether the app portal should be in read-only mode.}

typeAppPortalAccessOut ¶

type AppPortalAccessOut struct {Tokenstring `json:"token"`Urlstring `json:"url"`}

typeAppUsageStatsIn ¶

type AppUsageStatsIn struct {// Specific app IDs or UIDs to aggregate stats for.//// Note that if none of the given IDs or UIDs are resolved, a 422 response will be given.AppIds []string  `json:"appIds,omitempty"`Sincetime.Time `json:"since"`Untiltime.Time `json:"until"`}

typeAppUsageStatsOut ¶

type AppUsageStatsOut struct {Idstring               `json:"id"`// The QueueBackgroundTask's ID.StatusBackgroundTaskStatus `json:"status"`TaskBackgroundTaskType   `json:"task"`// Any app IDs or UIDs received in the request that weren't found.//// Stats will be produced for all the others.UnresolvedAppIds []string `json:"unresolvedAppIds"`}

typeApplicationIn ¶

type ApplicationIn struct {Metadata  *map[string]string `json:"metadata,omitempty"`Namestring             `json:"name"`RateLimit *uint16            `json:"rateLimit,omitempty"`Uid       *string            `json:"uid,omitempty"`// Optional unique identifier for the application.}

typeApplicationOut ¶

type ApplicationOut struct {CreatedAttime.Time         `json:"createdAt"`Idstring            `json:"id"`// The Application's ID.Metadata  map[string]string `json:"metadata"`Namestring            `json:"name"`RateLimit *uint16           `json:"rateLimit,omitempty"`Uid       *string           `json:"uid,omitempty"`// The Application's UID.UpdatedAttime.Time         `json:"updatedAt"`}

typeApplicationPatch ¶

type ApplicationPatch struct {Metadata  *map[string]string     `json:"metadata,omitempty"`Name      *string                `json:"name,omitempty"`RateLimitutils.Nullable[uint16] `json:"rateLimit"`Uidutils.Nullable[string] `json:"uid"`// The Application's UID.}

func (ApplicationPatch)MarshalJSON ¶

func (oApplicationPatch) MarshalJSON() ([]byte,error)

typeApplicationTokenExpireIn ¶

type ApplicationTokenExpireIn struct {Expiry *int64 `json:"expiry,omitempty"`// How many seconds until the old key is expired.}

typeBackgroundTaskFinishedEvent ¶added inv1.63.0

type BackgroundTaskFinishedEvent struct {DataBackgroundTaskFinishedEvent2 `json:"data"`Typestring                       `json:"type"`}

Sent when a background task is finished.

typeBackgroundTaskFinishedEvent2 ¶added inv1.63.0

type BackgroundTaskFinishedEvent2 struct {Data   map[string]any       `json:"data"`StatusBackgroundTaskStatus `json:"status"`TaskBackgroundTaskType   `json:"task"`TaskIdstring               `json:"taskId"`// The QueueBackgroundTask's ID.}

typeBackgroundTaskOut ¶

type BackgroundTaskOut struct {Data   map[string]any       `json:"data"`Idstring               `json:"id"`// The QueueBackgroundTask's ID.StatusBackgroundTaskStatus `json:"status"`TaskBackgroundTaskType   `json:"task"`}

typeBackgroundTaskStatus ¶

type BackgroundTaskStatusstring

const (BACKGROUNDTASKSTATUS_RUNNINGBackgroundTaskStatus = "running"BACKGROUNDTASKSTATUS_FINISHEDBackgroundTaskStatus = "finished"BACKGROUNDTASKSTATUS_FAILEDBackgroundTaskStatus = "failed")

func (*BackgroundTaskStatus)UnmarshalJSON ¶

func (v *BackgroundTaskStatus) UnmarshalJSON(src []byte)error

typeBackgroundTaskType ¶

type BackgroundTaskTypestring

const (BACKGROUNDTASKTYPE_ENDPOINT_REPLAYBackgroundTaskType = "endpoint.replay"BACKGROUNDTASKTYPE_ENDPOINT_RECOVERBackgroundTaskType = "endpoint.recover"BACKGROUNDTASKTYPE_APPLICATION_STATSBackgroundTaskType = "application.stats"BACKGROUNDTASKTYPE_MESSAGE_BROADCASTBackgroundTaskType = "message.broadcast"BACKGROUNDTASKTYPE_SDK_GENERATEBackgroundTaskType = "sdk.generate"BACKGROUNDTASKTYPE_EVENT_TYPE_AGGREGATEBackgroundTaskType = "event-type.aggregate"BACKGROUNDTASKTYPE_APPLICATION_PURGE_CONTENTBackgroundTaskType = "application.purge_content")

func (*BackgroundTaskType)UnmarshalJSON ¶

func (v *BackgroundTaskType) UnmarshalJSON(src []byte)error

typeBorderRadiusConfig ¶added inv1.64.1

type BorderRadiusConfig struct {Button *BorderRadiusEnum `json:"button,omitempty"`Card   *BorderRadiusEnum `json:"card,omitempty"`Input  *BorderRadiusEnum `json:"input,omitempty"`}

typeBorderRadiusEnum ¶added inv1.64.1

type BorderRadiusEnumstring

const (BORDERRADIUSENUM_NONEBorderRadiusEnum = "none"BORDERRADIUSENUM_LGBorderRadiusEnum = "lg"BORDERRADIUSENUM_MDBorderRadiusEnum = "md"BORDERRADIUSENUM_SMBorderRadiusEnum = "sm"BORDERRADIUSENUM_FULLBorderRadiusEnum = "full")

func (*BorderRadiusEnum)UnmarshalJSON ¶added inv1.64.1

func (v *BorderRadiusEnum) UnmarshalJSON(src []byte)error

typeConnectorIn ¶added inv1.58.2

type ConnectorIn struct {Description      *string        `json:"description,omitempty"`FeatureFlag      *string        `json:"featureFlag,omitempty"`FilterTypes      []string       `json:"filterTypes,omitempty"`Instructions     *string        `json:"instructions,omitempty"`InstructionsLink *string        `json:"instructionsLink,omitempty"`Kind             *ConnectorKind `json:"kind,omitempty"`Logostring         `json:"logo"`Namestring         `json:"name"`Transformationstring         `json:"transformation"`}

typeConnectorKind ¶added inv1.58.2

type ConnectorKindstring

const (CONNECTORKIND_CUSTOMConnectorKind = "Custom"CONNECTORKIND_CLOSE_CRMConnectorKind = "CloseCRM"CONNECTORKIND_CUSTOMER_IOConnectorKind = "CustomerIO"CONNECTORKIND_DISCORDConnectorKind = "Discord"CONNECTORKIND_HUBSPOTConnectorKind = "Hubspot"CONNECTORKIND_INNGESTConnectorKind = "Inngest"CONNECTORKIND_LOOPSConnectorKind = "Loops"CONNECTORKIND_RESENDConnectorKind = "Resend"CONNECTORKIND_SALESFORCEConnectorKind = "Salesforce"CONNECTORKIND_SEGMENTConnectorKind = "Segment"CONNECTORKIND_SENDGRIDConnectorKind = "Sendgrid"CONNECTORKIND_SLACKConnectorKind = "Slack"CONNECTORKIND_TEAMSConnectorKind = "Teams"CONNECTORKIND_TRIGGER_DEVConnectorKind = "TriggerDev"CONNECTORKIND_WINDMILLConnectorKind = "Windmill"CONNECTORKIND_ZAPIERConnectorKind = "Zapier")

func (*ConnectorKind)UnmarshalJSON ¶added inv1.58.2

func (v *ConnectorKind) UnmarshalJSON(src []byte)error

typeConnectorOut ¶added inv1.63.0

type ConnectorOut struct {CreatedAttime.Time     `json:"createdAt"`Descriptionstring        `json:"description"`FeatureFlag      *string       `json:"featureFlag,omitempty"`FilterTypes      []string      `json:"filterTypes,omitempty"`Idstring        `json:"id"`// The Connector's ID.Instructionsstring        `json:"instructions"`InstructionsLink *string       `json:"instructionsLink,omitempty"`KindConnectorKind `json:"kind"`Logostring        `json:"logo"`Namestring        `json:"name"`OrgIdstring        `json:"orgId"`// The Environment's ID.Transformationstring        `json:"transformation"`UpdatedAttime.Time     `json:"updatedAt"`}

typeCronConfig ¶added inv1.63.0

type CronConfig struct {// Override the default content-type.//// Recommended if the payload is not JSON.ContentType *string `json:"contentType,omitempty"`Payloadstring  `json:"payload"`Schedulestring  `json:"schedule"`}

typeCustomColorPalette ¶added inv1.64.1

type CustomColorPalette struct {BackgroundHover     *string `json:"backgroundHover,omitempty"`BackgroundPrimary   *string `json:"backgroundPrimary,omitempty"`BackgroundSecondary *string `json:"backgroundSecondary,omitempty"`ButtonPrimary       *string `json:"buttonPrimary,omitempty"`InteractiveAccent   *string `json:"interactiveAccent,omitempty"`NavigationAccent    *string `json:"navigationAccent,omitempty"`Primary             *string `json:"primary,omitempty"`TextDanger          *string `json:"textDanger,omitempty"`TextPrimary         *string `json:"textPrimary,omitempty"`}

typeCustomStringsOverride ¶added inv1.64.1

type CustomStringsOverride struct {ChannelsHelp *string `json:"channelsHelp,omitempty"`ChannelsMany *string `json:"channelsMany,omitempty"`ChannelsOne  *string `json:"channelsOne,omitempty"`}

typeCustomThemeOverride ¶added inv1.64.1

type CustomThemeOverride struct {BorderRadius *BorderRadiusConfig `json:"borderRadius,omitempty"`FontSize     *FontSizeConfig     `json:"fontSize,omitempty"`}

typeDashboardAccessOut ¶

type DashboardAccessOut struct {Tokenstring `json:"token"`Urlstring `json:"url"`}

typeDocusignConfig ¶added inv1.63.0

type DocusignConfig struct {Secret *string `json:"secret,omitempty"`}

typeDocusignConfigOut ¶added inv1.63.0

type DocusignConfigOut struct {}

typeEndpointCreatedEvent ¶added inv1.63.0

type EndpointCreatedEvent struct {DataEndpointCreatedEventData `json:"data"`Typestring                   `json:"type"`}

Sent when an endpoint is created.

typeEndpointCreatedEventData ¶added inv1.63.0

type EndpointCreatedEventData struct {AppIdstring  `json:"appId"`// The Application's ID.AppUid      *string `json:"appUid,omitempty"`// The Application's UID.EndpointIdstring  `json:"endpointId"`// The Endpoint's ID.EndpointUid *string `json:"endpointUid,omitempty"`// The Endpoint's UID.}

Sent when an endpoint is created, updated, or deleted

typeEndpointDeletedEvent ¶added inv1.63.0

type EndpointDeletedEvent struct {DataEndpointDeletedEventData `json:"data"`Typestring                   `json:"type"`}

Sent when an endpoint is deleted.

typeEndpointDeletedEventData ¶added inv1.63.0

type EndpointDeletedEventData struct {AppIdstring  `json:"appId"`// The Application's ID.AppUid      *string `json:"appUid,omitempty"`// The Application's UID.EndpointIdstring  `json:"endpointId"`// The Endpoint's ID.EndpointUid *string `json:"endpointUid,omitempty"`// The Endpoint's UID.}

Sent when an endpoint is created, updated, or deleted

typeEndpointDisabledEvent ¶added inv1.63.0

type EndpointDisabledEvent struct {DataEndpointDisabledEventData `json:"data"`Typestring                    `json:"type"`}

Sent when an endpoint has been automatically disabled after continuous failures, or manually via an API call.

typeEndpointDisabledEventData ¶added inv1.63.0

type EndpointDisabledEventData struct {AppIdstring                   `json:"appId"`// The Application's ID.AppUid      *string                  `json:"appUid,omitempty"`// The Application's UID.EndpointIdstring                   `json:"endpointId"`// The Endpoint's ID.EndpointUid *string                  `json:"endpointUid,omitempty"`// The Endpoint's UID.FailSince   *time.Time               `json:"failSince,omitempty"`Trigger     *EndpointDisabledTrigger `json:"trigger,omitempty"`}

Sent when an endpoint has been automatically disabled after continuous failures, or manually via an API call.

typeEndpointDisabledTrigger ¶added inv1.63.0

type EndpointDisabledTriggerstring

const (ENDPOINTDISABLEDTRIGGER_MANUALEndpointDisabledTrigger = "manual"ENDPOINTDISABLEDTRIGGER_AUTOMATICEndpointDisabledTrigger = "automatic")

func (*EndpointDisabledTrigger)UnmarshalJSON ¶added inv1.63.0

func (v *EndpointDisabledTrigger) UnmarshalJSON(src []byte)error

typeEndpointEnabledEvent ¶added inv1.63.0

type EndpointEnabledEvent struct {DataEndpointEnabledEventData `json:"data"`Typestring                   `json:"type"`}

Sent when an endpoint has been enabled.

typeEndpointEnabledEventData ¶added inv1.63.0

type EndpointEnabledEventData struct {AppIdstring  `json:"appId"`// The Application's ID.AppUid      *string `json:"appUid,omitempty"`// The Application's UID.EndpointIdstring  `json:"endpointId"`// The Endpoint's ID.EndpointUid *string `json:"endpointUid,omitempty"`// The Endpoint's UID.}

Sent when an endpoint has been enabled.

typeEndpointHeadersIn ¶

type EndpointHeadersIn struct {Headers map[string]string `json:"headers"`}

typeEndpointHeadersOut ¶

type EndpointHeadersOut struct {Headers   map[string]string `json:"headers"`Sensitive []string          `json:"sensitive"`}

The value of the headers is returned in the `headers` field.

Sensitive headers that have been redacted are returned in the sensitive field.

typeEndpointHeadersPatchIn ¶

type EndpointHeadersPatchIn struct {Headers map[string]string `json:"headers"`}

typeEndpointIn ¶

type EndpointIn struct {Channels    []string           `json:"channels,omitempty"`// List of message channels this endpoint listens to (omit for all).Description *string            `json:"description,omitempty"`Disabled    *bool              `json:"disabled,omitempty"`FilterTypes []string           `json:"filterTypes,omitempty"`Headers     *map[string]string `json:"headers,omitempty"`Metadata    *map[string]string `json:"metadata,omitempty"`RateLimit   *uint16            `json:"rateLimit,omitempty"`// The endpoint's verification secret.//// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.// It is recommended to not set this and let the server generate the secret.Secret  *string `json:"secret,omitempty"`Uid     *string `json:"uid,omitempty"`// Optional unique identifier for the endpoint.Urlstring  `json:"url"`Version *uint16 `json:"version,omitempty"`}

typeEndpointMessageOut ¶

type EndpointMessageOut struct {Channels    []string       `json:"channels,omitempty"`// List of free-form identifiers that endpoints can filter byEventId     *string        `json:"eventId,omitempty"`// Optional unique identifier for the messageEventTypestring         `json:"eventType"`// The event type's nameIdstring         `json:"id"`// The Message's ID.NextAttempt *time.Time     `json:"nextAttempt,omitempty"`Payload     map[string]any `json:"payload"`StatusMessageStatus  `json:"status"`Tags        []string       `json:"tags,omitempty"`Timestamptime.Time      `json:"timestamp"`}

A model containing information on a given message plus additional fields on the last attempt for that message.

typeEndpointOut ¶

type EndpointOut struct {Channels    []string          `json:"channels,omitempty"`// List of message channels this endpoint listens to (omit for all).CreatedAttime.Time         `json:"createdAt"`Descriptionstring            `json:"description"`// An example endpoint name.Disabled    *bool             `json:"disabled,omitempty"`FilterTypes []string          `json:"filterTypes,omitempty"`Idstring            `json:"id"`// The Endpoint's ID.Metadata    map[string]string `json:"metadata"`RateLimit   *uint16           `json:"rateLimit,omitempty"`Uid         *string           `json:"uid,omitempty"`// Optional unique identifier for the endpoint.UpdatedAttime.Time         `json:"updatedAt"`Urlstring            `json:"url"`Versionint32             `json:"version"`}

typeEndpointPatch ¶

type EndpointPatch struct {Channelsutils.Nullable[[]string] `json:"channels"`Description *string                  `json:"description,omitempty"`Disabled    *bool                    `json:"disabled,omitempty"`FilterTypesutils.Nullable[[]string] `json:"filterTypes"`Metadata    *map[string]string       `json:"metadata,omitempty"`RateLimitutils.Nullable[uint16]   `json:"rateLimit"`// The endpoint's verification secret.//// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.// It is recommended to not set this and let the server generate the secret.Secretutils.Nullable[string] `json:"secret"`Uidutils.Nullable[string] `json:"uid"`// The Endpoint's UID.Url     *string                `json:"url,omitempty"`Version *uint16                `json:"version,omitempty"`}

func (EndpointPatch)MarshalJSON ¶

func (oEndpointPatch) MarshalJSON() ([]byte,error)

typeEndpointSecretOut ¶

type EndpointSecretOut struct {// The endpoint's verification secret.//// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.// It is recommended to not set this and let the server generate the secret.Keystring `json:"key"`}

typeEndpointSecretRotateIn ¶

type EndpointSecretRotateIn struct {// The endpoint's verification secret.//// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.// It is recommended to not set this and let the server generate the secret.Key *string `json:"key,omitempty"`}

typeEndpointStats ¶

type EndpointStats struct {Failint64 `json:"fail"`Pendingint64 `json:"pending"`Sendingint64 `json:"sending"`Successint64 `json:"success"`}

typeEndpointTransformationIn ¶

type EndpointTransformationIn struct {Code    *string `json:"code,omitempty"`Enabled *bool   `json:"enabled,omitempty"`}

typeEndpointTransformationOut ¶

type EndpointTransformationOut struct {Code    *string `json:"code,omitempty"`Enabled *bool   `json:"enabled,omitempty"`}

typeEndpointUpdate ¶

type EndpointUpdate struct {Channels    []string           `json:"channels,omitempty"`// List of message channels this endpoint listens to (omit for all).Description *string            `json:"description,omitempty"`Disabled    *bool              `json:"disabled,omitempty"`FilterTypes []string           `json:"filterTypes,omitempty"`Metadata    *map[string]string `json:"metadata,omitempty"`RateLimit   *uint16            `json:"rateLimit,omitempty"`Uid         *string            `json:"uid,omitempty"`// Optional unique identifier for the endpoint.Urlstring             `json:"url"`Version     *uint16            `json:"version,omitempty"`}

typeEndpointUpdatedEvent ¶added inv1.63.0

type EndpointUpdatedEvent struct {DataEndpointUpdatedEventData `json:"data"`Typestring                   `json:"type"`}

Sent when an endpoint is updated.

typeEndpointUpdatedEventData ¶added inv1.63.0

type EndpointUpdatedEventData struct {AppIdstring  `json:"appId"`// The Application's ID.AppUid      *string `json:"appUid,omitempty"`// The Application's UID.EndpointIdstring  `json:"endpointId"`// The Endpoint's ID.EndpointUid *string `json:"endpointUid,omitempty"`// The Endpoint's UID.}

Sent when an endpoint is created, updated, or deleted

typeEnvironmentIn ¶

type EnvironmentIn struct {Connectors []ConnectorIn   `json:"connectors,omitempty"`EventTypes []EventTypeIn   `json:"eventTypes,omitempty"`Settings   *map[string]any `json:"settings,omitempty"`}

typeEnvironmentModelIn ¶added inv1.64.1

type EnvironmentModelIn struct {Namestring          `json:"name"`TypeEnvironmentType `json:"type"`}

typeEnvironmentModelOut ¶added inv1.64.1

type EnvironmentModelOut struct {CreatedAttime.Time         `json:"createdAt"`Idstring            `json:"id"`// The Environment's ID.Namestring            `json:"name"`RegionEnvironmentRegion `json:"region"`TypeEnvironmentType   `json:"type"`UpdatedAttime.Time         `json:"updatedAt"`}

typeEnvironmentModelUpdate ¶added inv1.64.1

type EnvironmentModelUpdate struct {Namestring `json:"name"`}

typeEnvironmentOut ¶

type EnvironmentOut struct {CreatedAttime.Time       `json:"createdAt"`EventTypes              []EventTypeOut  `json:"eventTypes"`Settings                *map[string]any `json:"settings,omitempty"`TransformationTemplates []ConnectorOut  `json:"transformationTemplates"`Version                 *int64          `json:"version,omitempty"`}

typeEnvironmentRegion ¶added inv1.64.1

type EnvironmentRegionstring

const (ENVIRONMENTREGION_EUEnvironmentRegion = "eu"ENVIRONMENTREGION_USEnvironmentRegion = "us"ENVIRONMENTREGION_INEnvironmentRegion = "in"ENVIRONMENTREGION_AUEnvironmentRegion = "au"ENVIRONMENTREGION_CAEnvironmentRegion = "ca"ENVIRONMENTREGION_SELF_HOSTEDEnvironmentRegion = "self-hosted")

func (*EnvironmentRegion)UnmarshalJSON ¶added inv1.64.1

func (v *EnvironmentRegion) UnmarshalJSON(src []byte)error

typeEnvironmentType ¶added inv1.64.1

type EnvironmentTypestring

const (ENVIRONMENTTYPE_DEVELOPMENTEnvironmentType = "development"ENVIRONMENTTYPE_PRODUCTIONEnvironmentType = "production")

func (*EnvironmentType)UnmarshalJSON ¶added inv1.64.1

func (v *EnvironmentType) UnmarshalJSON(src []byte)error

typeEventExampleIn ¶

type EventExampleIn struct {EventTypestring `json:"eventType"`// The event type's name// If the event type schema contains an array of examples, chooses which one to send.//// Defaults to the first example. Ignored if the schema doesn't contain an array of examples.ExampleIndex *uint64 `json:"exampleIndex,omitempty"`}

typeEventTypeFromOpenApi ¶

type EventTypeFromOpenApi struct {Deprecatedbool            `json:"deprecated"`Descriptionstring          `json:"description"`FeatureFlag *string         `json:"featureFlag,omitempty"`GroupName   *string         `json:"groupName,omitempty"`// The event type group's nameNamestring          `json:"name"`// The event type's nameSchemas     *map[string]any `json:"schemas,omitempty"`}

typeEventTypeImportOpenApiIn ¶

type EventTypeImportOpenApiIn struct {DryRun     *bool           `json:"dryRun,omitempty"`// If `true`, return the event types that would be modified without actually modifying them.ReplaceAll *bool           `json:"replaceAll,omitempty"`// If `true`, all existing event types that are not in the spec will be archived.Spec       *map[string]any `json:"spec,omitempty"`// A pre-parsed JSON spec.SpecRaw    *string         `json:"specRaw,omitempty"`// A string, parsed by the server as YAML or JSON.}

Import a list of event types from webhooks defined in an OpenAPI spec.

The OpenAPI spec can be specified as either `spec` given the spec as a JSON object, or as `specRaw` (a `string`) which will be parsed as YAML or JSON by the server. Sending neither or both is invalid, resulting in a `400` **Bad Request**.

typeEventTypeImportOpenApiOut ¶

type EventTypeImportOpenApiOut struct {DataEventTypeImportOpenApiOutData `json:"data"`}

typeEventTypeImportOpenApiOutData ¶

type EventTypeImportOpenApiOutData struct {Modified []string               `json:"modified"`ToModify []EventTypeFromOpenApi `json:"to_modify,omitempty"`}

typeEventTypeIn ¶

type EventTypeIn struct {Archived    *bool           `json:"archived,omitempty"`Deprecated  *bool           `json:"deprecated,omitempty"`Descriptionstring          `json:"description"`FeatureFlag *string         `json:"featureFlag,omitempty"`GroupName   *string         `json:"groupName,omitempty"`// The event type group's nameNamestring          `json:"name"`// The event type's nameSchemas     *map[string]any `json:"schemas,omitempty"`// The schema for the event type for a specific version as a JSON schema.}

typeEventTypeOut ¶

type EventTypeOut struct {Archived    *bool           `json:"archived,omitempty"`CreatedAttime.Time       `json:"createdAt"`Deprecatedbool            `json:"deprecated"`Descriptionstring          `json:"description"`FeatureFlag *string         `json:"featureFlag,omitempty"`GroupName   *string         `json:"groupName,omitempty"`// The event type group's nameNamestring          `json:"name"`// The event type's nameSchemas     *map[string]any `json:"schemas,omitempty"`// The schema for the event type for a specific version as a JSON schema.UpdatedAttime.Time       `json:"updatedAt"`}

typeEventTypePatch ¶

type EventTypePatch struct {Archived    *bool                          `json:"archived,omitempty"`Deprecated  *bool                          `json:"deprecated,omitempty"`Description *string                        `json:"description,omitempty"`FeatureFlagutils.Nullable[string]         `json:"featureFlag"`GroupNameutils.Nullable[string]         `json:"groupName"`// The event type group's nameSchemasutils.Nullable[map[string]any] `json:"schemas"`}

func (EventTypePatch)MarshalJSON ¶

func (oEventTypePatch) MarshalJSON() ([]byte,error)

typeEventTypeUpdate ¶

type EventTypeUpdate struct {Archived    *bool           `json:"archived,omitempty"`Deprecated  *bool           `json:"deprecated,omitempty"`Descriptionstring          `json:"description"`FeatureFlag *string         `json:"featureFlag,omitempty"`GroupName   *string         `json:"groupName,omitempty"`// The event type group's nameSchemas     *map[string]any `json:"schemas,omitempty"`// The schema for the event type for a specific version as a JSON schema.}

typeExpungAllContentsOut ¶added inv1.58.2

type ExpungAllContentsOut struct {Idstring               `json:"id"`// The QueueBackgroundTask's ID.StatusBackgroundTaskStatus `json:"status"`TaskBackgroundTaskType   `json:"task"`}

typeExpungeAllContentsOut ¶added inv1.61.1

type ExpungeAllContentsOut struct {Idstring               `json:"id"`// The QueueBackgroundTask's ID.StatusBackgroundTaskStatus `json:"status"`TaskBackgroundTaskType   `json:"task"`}

typeFontSizeConfig ¶added inv1.64.1

type FontSizeConfig struct {Base *uint16 `json:"base,omitempty"`}

typeGithubConfig ¶added inv1.63.0

type GithubConfig struct {Secret *string `json:"secret,omitempty"`}

typeGithubConfigOut ¶added inv1.63.0

type GithubConfigOut struct {}

typeHubspotConfig ¶added inv1.63.0

type HubspotConfig struct {Secret *string `json:"secret,omitempty"`}

typeHubspotConfigOut ¶added inv1.63.0

type HubspotConfigOut struct {}

typeIngestEndpointHeadersIn ¶added inv1.61.1

type IngestEndpointHeadersIn struct {Headers map[string]string `json:"headers"`}

typeIngestEndpointHeadersOut ¶added inv1.61.1

type IngestEndpointHeadersOut struct {Headers   map[string]string `json:"headers"`Sensitive []string          `json:"sensitive"`}

typeIngestEndpointIn ¶added inv1.61.1

type IngestEndpointIn struct {Description *string            `json:"description,omitempty"`Disabled    *bool              `json:"disabled,omitempty"`Metadata    *map[string]string `json:"metadata,omitempty"`RateLimit   *uint16            `json:"rateLimit,omitempty"`// The endpoint's verification secret.//// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.// It is recommended to not set this and let the server generate the secret.Secret *string `json:"secret,omitempty"`Uid    *string `json:"uid,omitempty"`// Optional unique identifier for the endpoint.Urlstring  `json:"url"`}

typeIngestEndpointOut ¶added inv1.61.1

type IngestEndpointOut struct {CreatedAttime.Time         `json:"createdAt"`Descriptionstring            `json:"description"`// An example endpoint name.Disabled    *bool             `json:"disabled,omitempty"`Idstring            `json:"id"`// The Endpoint's ID.Metadata    map[string]string `json:"metadata"`RateLimit   *uint16           `json:"rateLimit,omitempty"`Uid         *string           `json:"uid,omitempty"`// Optional unique identifier for the endpoint.UpdatedAttime.Time         `json:"updatedAt"`Urlstring            `json:"url"`}

typeIngestEndpointSecretIn ¶added inv1.61.1

type IngestEndpointSecretIn struct {// The endpoint's verification secret.//// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.// It is recommended to not set this and let the server generate the secret.Key *string `json:"key,omitempty"`}

typeIngestEndpointSecretOut ¶added inv1.61.1

type IngestEndpointSecretOut struct {// The endpoint's verification secret.//// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.// It is recommended to not set this and let the server generate the secret.Keystring `json:"key"`}

typeIngestEndpointUpdate ¶added inv1.61.1

type IngestEndpointUpdate struct {Description *string            `json:"description,omitempty"`Disabled    *bool              `json:"disabled,omitempty"`Metadata    *map[string]string `json:"metadata,omitempty"`RateLimit   *uint16            `json:"rateLimit,omitempty"`Uid         *string            `json:"uid,omitempty"`// Optional unique identifier for the endpoint.Urlstring             `json:"url"`}

typeIngestSourceConsumerPortalAccessIn ¶added inv1.63.0

type IngestSourceConsumerPortalAccessIn struct {// How long the token will be valid for, in seconds.//// Valid values are between 1 hour and 7 days. The default is 7 days.Expiry   *uint64 `json:"expiry,omitempty"`ReadOnly *bool   `json:"readOnly,omitempty"`// Whether the app portal should be in read-only mode.}

typeIngestSourceIn ¶added inv1.63.0

type IngestSourceIn struct {Namestring               `json:"name"`Uid    *string              `json:"uid,omitempty"`// The Source's UID.TypeIngestSourceInType   `json:"type"`ConfigIngestSourceInConfig `json:"config"`}

When creating an IngestSourceIn, use the appropriate config structure based on the Type:

"generic-webhook": No config needed (nil or just ignore the config field)
"adobe-sign": Use AdobeSignConfig
"cron": Use CronConfig
"docusign": Use DocusignConfig
"github": Use GithubConfig
"hubspot": Use HubspotConfig
"panda-doc": Use PandaDocConfig
"segment": Use SegmentConfig
"shopify": Use ShopifyConfig
"slack": Use SlackConfig
"stripe": Use StripeConfig
"beehiiv","brex","clerk","guesty","incident-io","lithic","nash","pleo","replicate","resend","safebase","sardine","stych","svix": Use SvixConfig
"zoom": Use ZoomConfig

func (IngestSourceIn)MarshalJSON ¶added inv1.63.0

func (iIngestSourceIn) MarshalJSON() ([]byte,error)

func (*IngestSourceIn)UnmarshalJSON ¶added inv1.63.0

func (i *IngestSourceIn) UnmarshalJSON(data []byte)error

typeIngestSourceInConfig ¶added inv1.63.0

type IngestSourceInConfig interface {// contains filtered or unexported methods}

typeIngestSourceInType ¶added inv1.63.0

type IngestSourceInTypestring

const (IngestSourceInTypeGenericWebhookIngestSourceInType = "generic-webhook"IngestSourceInTypeCronIngestSourceInType = "cron"IngestSourceInTypeAdobeSignIngestSourceInType = "adobe-sign"IngestSourceInTypeBeehiivIngestSourceInType = "beehiiv"IngestSourceInTypeBrexIngestSourceInType = "brex"IngestSourceInTypeClerkIngestSourceInType = "clerk"IngestSourceInTypeDocusignIngestSourceInType = "docusign"IngestSourceInTypeGithubIngestSourceInType = "github"IngestSourceInTypeGuestyIngestSourceInType = "guesty"IngestSourceInTypeHubspotIngestSourceInType = "hubspot"IngestSourceInTypeIncidentIoIngestSourceInType = "incident-io"IngestSourceInTypeLithicIngestSourceInType = "lithic"IngestSourceInTypeNashIngestSourceInType = "nash"IngestSourceInTypePandaDocIngestSourceInType = "panda-doc"IngestSourceInTypePleoIngestSourceInType = "pleo"IngestSourceInTypeReplicateIngestSourceInType = "replicate"IngestSourceInTypeResendIngestSourceInType = "resend"IngestSourceInTypeSafebaseIngestSourceInType = "safebase"IngestSourceInTypeSardineIngestSourceInType = "sardine"IngestSourceInTypeSegmentIngestSourceInType = "segment"IngestSourceInTypeShopifyIngestSourceInType = "shopify"IngestSourceInTypeSlackIngestSourceInType = "slack"IngestSourceInTypeStripeIngestSourceInType = "stripe"IngestSourceInTypeStychIngestSourceInType = "stych"IngestSourceInTypeSvixIngestSourceInType = "svix"IngestSourceInTypeZoomIngestSourceInType = "zoom")

typeIngestSourceOut ¶added inv1.63.0

type IngestSourceOut struct {CreatedAttime.Time             `json:"createdAt"`Idstring                `json:"id"`// The Source's ID.IngestUrl *string               `json:"ingestUrl,omitempty"`Namestring                `json:"name"`Uid       *string               `json:"uid,omitempty"`// The Source's UID.UpdatedAttime.Time             `json:"updatedAt"`TypeIngestSourceOutType   `json:"type"`ConfigIngestSourceOutConfig `json:"config"`}

When creating an IngestSourceOut, use the appropriate config structure based on the Type:

"generic-webhook": No config needed (nil or just ignore the config field)
"adobe-sign": Use AdobeSignConfigOut
"cron": Use CronConfig
"docusign": Use DocusignConfigOut
"github": Use GithubConfigOut
"hubspot": Use HubspotConfigOut
"panda-doc": Use PandaDocConfigOut
"segment": Use SegmentConfigOut
"shopify": Use ShopifyConfigOut
"slack": Use SlackConfigOut
"stripe": Use StripeConfigOut
"beehiiv","brex","clerk","guesty","incident-io","lithic","nash","pleo","replicate","resend","safebase","sardine","stych","svix": Use SvixConfigOut
"zoom": Use ZoomConfigOut

func (IngestSourceOut)MarshalJSON ¶added inv1.63.0

func (iIngestSourceOut) MarshalJSON() ([]byte,error)

func (*IngestSourceOut)UnmarshalJSON ¶added inv1.63.0

func (i *IngestSourceOut) UnmarshalJSON(data []byte)error

typeIngestSourceOutConfig ¶added inv1.63.0

type IngestSourceOutConfig interface {// contains filtered or unexported methods}

typeIngestSourceOutType ¶added inv1.63.0

type IngestSourceOutTypestring

const (IngestSourceOutTypeGenericWebhookIngestSourceOutType = "generic-webhook"IngestSourceOutTypeCronIngestSourceOutType = "cron"IngestSourceOutTypeAdobeSignIngestSourceOutType = "adobe-sign"IngestSourceOutTypeBeehiivIngestSourceOutType = "beehiiv"IngestSourceOutTypeBrexIngestSourceOutType = "brex"IngestSourceOutTypeClerkIngestSourceOutType = "clerk"IngestSourceOutTypeDocusignIngestSourceOutType = "docusign"IngestSourceOutTypeGithubIngestSourceOutType = "github"IngestSourceOutTypeGuestyIngestSourceOutType = "guesty"IngestSourceOutTypeHubspotIngestSourceOutType = "hubspot"IngestSourceOutTypeIncidentIoIngestSourceOutType = "incident-io"IngestSourceOutTypeLithicIngestSourceOutType = "lithic"IngestSourceOutTypeNashIngestSourceOutType = "nash"IngestSourceOutTypePandaDocIngestSourceOutType = "panda-doc"IngestSourceOutTypePleoIngestSourceOutType = "pleo"IngestSourceOutTypeReplicateIngestSourceOutType = "replicate"IngestSourceOutTypeResendIngestSourceOutType = "resend"IngestSourceOutTypeSafebaseIngestSourceOutType = "safebase"IngestSourceOutTypeSardineIngestSourceOutType = "sardine"IngestSourceOutTypeSegmentIngestSourceOutType = "segment"IngestSourceOutTypeShopifyIngestSourceOutType = "shopify"IngestSourceOutTypeSlackIngestSourceOutType = "slack"IngestSourceOutTypeStripeIngestSourceOutType = "stripe"IngestSourceOutTypeStychIngestSourceOutType = "stych"IngestSourceOutTypeSvixIngestSourceOutType = "svix"IngestSourceOutTypeZoomIngestSourceOutType = "zoom")

typeIntegrationIn ¶

type IntegrationIn struct {FeatureFlags []string `json:"featureFlags,omitempty"`// The set of feature flags the integration will have access to.Namestring   `json:"name"`}

typeIntegrationKeyOut ¶

type IntegrationKeyOut struct {Keystring `json:"key"`}

typeIntegrationOut ¶

type IntegrationOut struct {CreatedAttime.Time `json:"createdAt"`FeatureFlags []string  `json:"featureFlags,omitempty"`// The set of feature flags the integration has access to.Idstring    `json:"id"`// The Integration's ID.Namestring    `json:"name"`UpdatedAttime.Time `json:"updatedAt"`}

typeIntegrationUpdate ¶

type IntegrationUpdate struct {FeatureFlags []string `json:"featureFlags,omitempty"`// The set of feature flags the integration will have access to.Namestring   `json:"name"`}

typeListResponseApiTokenCensoredOut ¶added inv1.63.1

type ListResponseApiTokenCensoredOut struct {Data         []ApiTokenCensoredOut `json:"data"`Donebool                  `json:"done"`Iterator     *string               `json:"iterator,omitempty"`PrevIterator *string               `json:"prevIterator,omitempty"`}

typeListResponseApplicationOut ¶

type ListResponseApplicationOut struct {Data         []ApplicationOut `json:"data"`Donebool             `json:"done"`Iterator     *string          `json:"iterator,omitempty"`PrevIterator *string          `json:"prevIterator,omitempty"`}

typeListResponseBackgroundTaskOut ¶

type ListResponseBackgroundTaskOut struct {Data         []BackgroundTaskOut `json:"data"`Donebool                `json:"done"`Iterator     *string             `json:"iterator,omitempty"`PrevIterator *string             `json:"prevIterator,omitempty"`}

typeListResponseEndpointMessageOut ¶

type ListResponseEndpointMessageOut struct {Data         []EndpointMessageOut `json:"data"`Donebool                 `json:"done"`Iterator     *string              `json:"iterator,omitempty"`PrevIterator *string              `json:"prevIterator,omitempty"`}

typeListResponseEndpointOut ¶

type ListResponseEndpointOut struct {Data         []EndpointOut `json:"data"`Donebool          `json:"done"`Iterator     *string       `json:"iterator,omitempty"`PrevIterator *string       `json:"prevIterator,omitempty"`}

typeListResponseEnvironmentModelOut ¶added inv1.64.1

type ListResponseEnvironmentModelOut struct {Data         []EnvironmentModelOut `json:"data"`Donebool                  `json:"done"`Iterator     *string               `json:"iterator,omitempty"`PrevIterator *string               `json:"prevIterator,omitempty"`}

typeListResponseEventTypeOut ¶

type ListResponseEventTypeOut struct {Data         []EventTypeOut `json:"data"`Donebool           `json:"done"`Iterator     *string        `json:"iterator,omitempty"`PrevIterator *string        `json:"prevIterator,omitempty"`}

typeListResponseIngestEndpointOut ¶added inv1.61.1

type ListResponseIngestEndpointOut struct {Data         []IngestEndpointOut `json:"data"`Donebool                `json:"done"`Iterator     *string             `json:"iterator,omitempty"`PrevIterator *string             `json:"prevIterator,omitempty"`}

typeListResponseIngestSourceOut ¶added inv1.63.0

type ListResponseIngestSourceOut struct {Data         []IngestSourceOut `json:"data"`Donebool              `json:"done"`Iterator     *string           `json:"iterator,omitempty"`PrevIterator *string           `json:"prevIterator,omitempty"`}

typeListResponseIntegrationOut ¶

type ListResponseIntegrationOut struct {Data         []IntegrationOut `json:"data"`Donebool             `json:"done"`Iterator     *string          `json:"iterator,omitempty"`PrevIterator *string          `json:"prevIterator,omitempty"`}

typeListResponseMessageAttemptOut ¶

type ListResponseMessageAttemptOut struct {Data         []MessageAttemptOut `json:"data"`Donebool                `json:"done"`Iterator     *string             `json:"iterator,omitempty"`PrevIterator *string             `json:"prevIterator,omitempty"`}

typeListResponseMessageEndpointOut ¶

type ListResponseMessageEndpointOut struct {Data         []MessageEndpointOut `json:"data"`Donebool                 `json:"done"`Iterator     *string              `json:"iterator,omitempty"`PrevIterator *string              `json:"prevIterator,omitempty"`}

typeListResponseMessageOut ¶

type ListResponseMessageOut struct {Data         []MessageOut `json:"data"`Donebool         `json:"done"`Iterator     *string      `json:"iterator,omitempty"`PrevIterator *string      `json:"prevIterator,omitempty"`}

typeListResponseOperationalWebhookEndpointOut ¶

type ListResponseOperationalWebhookEndpointOut struct {Data         []OperationalWebhookEndpointOut `json:"data"`Donebool                            `json:"done"`Iterator     *string                         `json:"iterator,omitempty"`PrevIterator *string                         `json:"prevIterator,omitempty"`}

typeMessageAttemptExhaustedEvent ¶added inv1.63.0

type MessageAttemptExhaustedEvent struct {DataMessageAttemptExhaustedEventData `json:"data"`Typestring                           `json:"type"`}

Sent when a message delivery has failed (all of the retry attempts have been exhausted).

typeMessageAttemptExhaustedEventData ¶added inv1.63.0

type MessageAttemptExhaustedEventData struct {AppIdstring                   `json:"appId"`// The Application's ID.AppUid      *string                  `json:"appUid,omitempty"`// The Application's UID.EndpointIdstring                   `json:"endpointId"`// The Endpoint's ID.LastAttemptMessageAttemptFailedData `json:"lastAttempt"`MsgEventId  *string                  `json:"msgEventId,omitempty"`// The Message's UID.MsgIdstring                   `json:"msgId"`// The Message's ID.}

Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "message.attempt.exhausted" type or after it's failed four times as a "message.attempt.failing" event.

typeMessageAttemptFailedData ¶added inv1.63.0

type MessageAttemptFailedData struct {Idstring    `json:"id"`// The MessageAttempt's ID.ResponseStatusCodeint16     `json:"responseStatusCode"`Timestamptime.Time `json:"timestamp"`}

typeMessageAttemptFailingEvent ¶added inv1.63.0

type MessageAttemptFailingEvent struct {DataMessageAttemptFailingEventData `json:"data"`Typestring                         `json:"type"`}

Sent after a message has been failing for a few times.It's sent on the fourth failure. It complements `message.attempt.exhausted` which is sent after the last failure.

typeMessageAttemptFailingEventData ¶added inv1.63.0

type MessageAttemptFailingEventData struct {AppIdstring                   `json:"appId"`// The Application's ID.AppUid      *string                  `json:"appUid,omitempty"`// The Application's UID.EndpointIdstring                   `json:"endpointId"`// The Endpoint's ID.LastAttemptMessageAttemptFailedData `json:"lastAttempt"`MsgEventId  *string                  `json:"msgEventId,omitempty"`// The Message's UID.MsgIdstring                   `json:"msgId"`// The Message's ID.}

Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "message.attempt.exhausted" type or after it's failed four times as a "message.attempt.failing" event.

typeMessageAttemptOut ¶

type MessageAttemptOut struct {EndpointIdstring                    `json:"endpointId"`// The Endpoint's ID.Idstring                    `json:"id"`// The MessageAttempt's ID.Msg                *MessageOut               `json:"msg,omitempty"`MsgIdstring                    `json:"msgId"`// The Message's ID.Responsestring                    `json:"response"`ResponseDurationMsint64                     `json:"responseDurationMs"`// Response duration in milliseconds.ResponseStatusCodeint16                     `json:"responseStatusCode"`StatusMessageStatus             `json:"status"`Timestamptime.Time                 `json:"timestamp"`TriggerTypeMessageAttemptTriggerType `json:"triggerType"`Urlstring                    `json:"url"`}

typeMessageAttemptRecoveredEvent ¶added inv1.63.0

type MessageAttemptRecoveredEvent struct {DataMessageAttemptRecoveredEventData `json:"data"`Typestring                           `json:"type"`}

Sent on a successful dispatch after an earlier failure op webhook has already been sent.

typeMessageAttemptRecoveredEventData ¶added inv1.63.0

type MessageAttemptRecoveredEventData struct {AppIdstring                   `json:"appId"`// The Application's ID.AppUid      *string                  `json:"appUid,omitempty"`// The Application's UID.EndpointIdstring                   `json:"endpointId"`// The Endpoint's ID.LastAttemptMessageAttemptFailedData `json:"lastAttempt"`MsgEventId  *string                  `json:"msgEventId,omitempty"`// The Message's UID.MsgIdstring                   `json:"msgId"`// The Message's ID.}

Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "message.attempt.exhausted" type or after it's failed four times as a "message.attempt.failing" event.

typeMessageAttemptTriggerType ¶

type MessageAttemptTriggerTypeint64

The reason an attempt was made:- Scheduled = 0- Manual = 1

const (MESSAGEATTEMPTTRIGGERTYPE_SCHEDULEDMessageAttemptTriggerType = 0MESSAGEATTEMPTTRIGGERTYPE_MANUALMessageAttemptTriggerType = 1)

func (*MessageAttemptTriggerType)UnmarshalJSON ¶

func (v *MessageAttemptTriggerType) UnmarshalJSON(src []byte)error

typeMessageEndpointOut ¶

type MessageEndpointOut struct {Channels    []string      `json:"channels,omitempty"`// List of message channels this endpoint listens to (omit for all).CreatedAttime.Time     `json:"createdAt"`Descriptionstring        `json:"description"`// An example endpoint name.Disabled    *bool         `json:"disabled,omitempty"`FilterTypes []string      `json:"filterTypes,omitempty"`Idstring        `json:"id"`// The Endpoint's ID.NextAttempt *time.Time    `json:"nextAttempt,omitempty"`RateLimit   *uint16       `json:"rateLimit,omitempty"`StatusMessageStatus `json:"status"`Uid         *string       `json:"uid,omitempty"`// Optional unique identifier for the endpoint.UpdatedAttime.Time     `json:"updatedAt"`Urlstring        `json:"url"`Versionint32         `json:"version"`}

typeMessageIn ¶

type MessageIn struct {// Optionally creates a new application alongside the message.//// If the application id or uid that is used in the path already exists, this argument is ignored.Application *ApplicationIn `json:"application,omitempty"`Channels    []string       `json:"channels,omitempty"`// List of free-form identifiers that endpoints can filter byEventId     *string        `json:"eventId,omitempty"`// Optional unique identifier for the messageEventTypestring         `json:"eventType"`// The event type's name// JSON payload to send as the request body of the webhook.//// We also support sending non-JSON payloads. Please contact us for more information.Payload                map[string]any  `json:"payload"`PayloadRetentionHours  *int64          `json:"payloadRetentionHours,omitempty"`// Optional number of hours to retain the message payload. Note that this is mutually exclusive with `payloadRetentionPeriod`.PayloadRetentionPeriod *int64          `json:"payloadRetentionPeriod,omitempty"`// Optional number of days to retain the message payload. Defaults to 90. Note that this is mutually exclusive with `payloadRetentionHours`.Tags                   []string        `json:"tags,omitempty"`// List of free-form tags that can be filtered by when listing messagesTransformationsParams  *map[string]any `json:"transformationsParams,omitempty"`// Extra parameters to pass to Transformations (for future use)}

typeMessageOut ¶

type MessageOut struct {Channels  []string       `json:"channels,omitempty"`// List of free-form identifiers that endpoints can filter byEventId   *string        `json:"eventId,omitempty"`// Optional unique identifier for the messageEventTypestring         `json:"eventType"`// The event type's nameIdstring         `json:"id"`// The Message's ID.Payload   map[string]any `json:"payload"`Tags      []string       `json:"tags,omitempty"`Timestamptime.Time      `json:"timestamp"`}

typeMessageStatus ¶

type MessageStatusint64

The sending status of the message:- Success = 0- Pending = 1- Fail = 2- Sending = 3

const (MESSAGESTATUS_SUCCESSMessageStatus = 0MESSAGESTATUS_PENDINGMessageStatus = 1MESSAGESTATUS_FAILMessageStatus = 2MESSAGESTATUS_SENDINGMessageStatus = 3)

func (*MessageStatus)UnmarshalJSON ¶

func (v *MessageStatus) UnmarshalJSON(src []byte)error

typeOperationalWebhookEndpointHeadersIn ¶

type OperationalWebhookEndpointHeadersIn struct {Headers map[string]string `json:"headers"`}

typeOperationalWebhookEndpointHeadersOut ¶

type OperationalWebhookEndpointHeadersOut struct {Headers   map[string]string `json:"headers"`Sensitive []string          `json:"sensitive"`}

typeOperationalWebhookEndpointIn ¶

type OperationalWebhookEndpointIn struct {Description *string            `json:"description,omitempty"`Disabled    *bool              `json:"disabled,omitempty"`FilterTypes []string           `json:"filterTypes,omitempty"`Metadata    *map[string]string `json:"metadata,omitempty"`RateLimit   *uint16            `json:"rateLimit,omitempty"`// The endpoint's verification secret.//// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.// It is recommended to not set this and let the server generate the secret.Secret *string `json:"secret,omitempty"`Uid    *string `json:"uid,omitempty"`// Optional unique identifier for the endpoint.Urlstring  `json:"url"`}

typeOperationalWebhookEndpointOut ¶

type OperationalWebhookEndpointOut struct {CreatedAttime.Time         `json:"createdAt"`Descriptionstring            `json:"description"`// An example endpoint name.Disabled    *bool             `json:"disabled,omitempty"`FilterTypes []string          `json:"filterTypes,omitempty"`Idstring            `json:"id"`// The Endpoint's ID.Metadata    map[string]string `json:"metadata"`RateLimit   *uint16           `json:"rateLimit,omitempty"`Uid         *string           `json:"uid,omitempty"`// Optional unique identifier for the endpoint.UpdatedAttime.Time         `json:"updatedAt"`Urlstring            `json:"url"`}

typeOperationalWebhookEndpointSecretIn ¶

type OperationalWebhookEndpointSecretIn struct {// The endpoint's verification secret.//// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.// It is recommended to not set this and let the server generate the secret.Key *string `json:"key,omitempty"`}

typeOperationalWebhookEndpointSecretOut ¶

type OperationalWebhookEndpointSecretOut struct {// The endpoint's verification secret.//// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.// It is recommended to not set this and let the server generate the secret.Keystring `json:"key"`}

typeOperationalWebhookEndpointUpdate ¶

type OperationalWebhookEndpointUpdate struct {Description *string            `json:"description,omitempty"`Disabled    *bool              `json:"disabled,omitempty"`FilterTypes []string           `json:"filterTypes,omitempty"`Metadata    *map[string]string `json:"metadata,omitempty"`RateLimit   *uint16            `json:"rateLimit,omitempty"`Uid         *string            `json:"uid,omitempty"`// Optional unique identifier for the endpoint.Urlstring             `json:"url"`}

typeOrdering ¶

type Orderingstring

Defines the ordering in a listing of results.

const (ORDERING_ASCENDINGOrdering = "ascending"ORDERING_DESCENDINGOrdering = "descending")

func (*Ordering)UnmarshalJSON ¶

func (v *Ordering) UnmarshalJSON(src []byte)error

typePandaDocConfig ¶added inv1.67.0

type PandaDocConfig struct {Secretstring `json:"secret"`}

typePandaDocConfigOut ¶added inv1.67.0

type PandaDocConfigOut struct {}

typePollingEndpointConsumerSeekIn ¶added inv1.63.0

type PollingEndpointConsumerSeekIn struct {Aftertime.Time `json:"after"`}

typePollingEndpointConsumerSeekOut ¶added inv1.63.0

type PollingEndpointConsumerSeekOut struct {Iteratorstring `json:"iterator"`}

typePollingEndpointMessageOut ¶added inv1.63.0

type PollingEndpointMessageOut struct {Channels  []string           `json:"channels,omitempty"`// List of free-form identifiers that endpoints can filter byEventId   *string            `json:"eventId,omitempty"`// Optional unique identifier for the messageEventTypestring             `json:"eventType"`// The event type's nameHeaders   *map[string]string `json:"headers,omitempty"`Idstring             `json:"id"`// The Message's ID.Payload   map[string]any     `json:"payload"`Tags      []string           `json:"tags,omitempty"`Timestamptime.Time          `json:"timestamp"`}

The MessageOut equivalent of polling endpoint

typePollingEndpointOut ¶added inv1.63.0

type PollingEndpointOut struct {Data     []PollingEndpointMessageOut `json:"data"`Donebool                        `json:"done"`Iteratorstring                      `json:"iterator"`}

typeRecoverIn ¶

type RecoverIn struct {Sincetime.Time  `json:"since"`Until *time.Time `json:"until,omitempty"`}

typeRecoverOut ¶

type RecoverOut struct {Idstring               `json:"id"`// The QueueBackgroundTask's ID.StatusBackgroundTaskStatus `json:"status"`TaskBackgroundTaskType   `json:"task"`}

typeReplayIn ¶

type ReplayIn struct {Sincetime.Time  `json:"since"`Until *time.Time `json:"until,omitempty"`}

typeReplayOut ¶

type ReplayOut struct {Idstring               `json:"id"`// The QueueBackgroundTask's ID.StatusBackgroundTaskStatus `json:"status"`TaskBackgroundTaskType   `json:"task"`}

typeRotateTokenOut ¶added inv1.63.0

type RotateTokenOut struct {IngestUrlstring `json:"ingestUrl"`}

typeSegmentConfig ¶added inv1.63.0

type SegmentConfig struct {Secret *string `json:"secret,omitempty"`}

typeSegmentConfigOut ¶added inv1.63.0

type SegmentConfigOut struct {}

typeSettingsInternalIn ¶added inv1.64.1

type SettingsInternalIn struct {ColorPaletteDark            *CustomColorPalette    `json:"colorPaletteDark,omitempty"`ColorPaletteLight           *CustomColorPalette    `json:"colorPaletteLight,omitempty"`CustomBaseFontSize          *int64                 `json:"customBaseFontSize,omitempty"`CustomColor                 *string                `json:"customColor,omitempty"`CustomFontFamily            *string                `json:"customFontFamily,omitempty"`CustomFontFamilyUrl         *string                `json:"customFontFamilyUrl,omitempty"`CustomLogoUrl               *string                `json:"customLogoUrl,omitempty"`CustomStringsOverride       *CustomStringsOverride `json:"customStringsOverride,omitempty"`CustomThemeOverride         *CustomThemeOverride   `json:"customThemeOverride,omitempty"`DisableEndpointOnFailure    *bool                  `json:"disableEndpointOnFailure,omitempty"`DisplayName                 *string                `json:"displayName,omitempty"`EnableChannels              *bool                  `json:"enableChannels,omitempty"`EnableEndpointMtlsConfig    *bool                  `json:"enableEndpointMtlsConfig,omitempty"`EnableEndpointOauthConfig   *bool                  `json:"enableEndpointOauthConfig,omitempty"`EnableIntegrationManagement *bool                  `json:"enableIntegrationManagement,omitempty"`EnableMessageStream         *bool                  `json:"enableMessageStream,omitempty"`EnableMsgAtmptLog           *bool                  `json:"enableMsgAtmptLog,omitempty"`EnableOtlp                  *bool                  `json:"enableOtlp,omitempty"`EnableTransformations       *bool                  `json:"enableTransformations,omitempty"`EnforceHttps                *bool                  `json:"enforceHttps,omitempty"`EventCatalogPublished       *bool                  `json:"eventCatalogPublished,omitempty"`ReadOnly                    *bool                  `json:"readOnly,omitempty"`RequireEndpointChannel      *bool                  `json:"requireEndpointChannel,omitempty"`RequireEndpointFilterTypes  *bool                  `json:"requireEndpointFilterTypes,omitempty"`RetryPolicy                 []int32                `json:"retryPolicy,omitempty"`ShowUseSvixPlay             *bool                  `json:"showUseSvixPlay,omitempty"`WhitelabelHeaders           *bool                  `json:"whitelabelHeaders,omitempty"`WipeSuccessfulPayload       *bool                  `json:"wipeSuccessfulPayload,omitempty"`}

typeSettingsInternalOut ¶added inv1.64.1

type SettingsInternalOut struct {ColorPaletteDark            *CustomColorPalette    `json:"colorPaletteDark,omitempty"`ColorPaletteLight           *CustomColorPalette    `json:"colorPaletteLight,omitempty"`CustomBaseFontSize          *int64                 `json:"customBaseFontSize,omitempty"`CustomColor                 *string                `json:"customColor,omitempty"`CustomFontFamily            *string                `json:"customFontFamily,omitempty"`CustomFontFamilyUrl         *string                `json:"customFontFamilyUrl,omitempty"`CustomLogoUrl               *string                `json:"customLogoUrl,omitempty"`CustomStringsOverride       *CustomStringsOverride `json:"customStringsOverride,omitempty"`CustomThemeOverride         *CustomThemeOverride   `json:"customThemeOverride,omitempty"`DisableEndpointOnFailure    *bool                  `json:"disableEndpointOnFailure,omitempty"`DisplayName                 *string                `json:"displayName,omitempty"`EnableChannels              *bool                  `json:"enableChannels,omitempty"`EnableEndpointMtlsConfig    *bool                  `json:"enableEndpointMtlsConfig,omitempty"`EnableEndpointOauthConfig   *bool                  `json:"enableEndpointOauthConfig,omitempty"`EnableIntegrationManagement *bool                  `json:"enableIntegrationManagement,omitempty"`EnableMessageStream         *bool                  `json:"enableMessageStream,omitempty"`EnableMsgAtmptLog           *bool                  `json:"enableMsgAtmptLog,omitempty"`EnableOtlp                  *bool                  `json:"enableOtlp,omitempty"`EnableTransformations       *bool                  `json:"enableTransformations,omitempty"`EnforceHttps                *bool                  `json:"enforceHttps,omitempty"`EventCatalogPublished       *bool                  `json:"eventCatalogPublished,omitempty"`ReadOnly                    *bool                  `json:"readOnly,omitempty"`RequireEndpointChannel      *bool                  `json:"requireEndpointChannel,omitempty"`RequireEndpointFilterTypes  *bool                  `json:"requireEndpointFilterTypes,omitempty"`RetryPolicy                 []int32                `json:"retryPolicy,omitempty"`ShowSvixBrandFooter         *bool                  `json:"showSvixBrandFooter,omitempty"`ShowUseSvixPlay             *bool                  `json:"showUseSvixPlay,omitempty"`WhitelabelHeaders           *bool                  `json:"whitelabelHeaders,omitempty"`WipeSuccessfulPayload       *bool                  `json:"wipeSuccessfulPayload,omitempty"`}

typeSettingsInternalUpdateOut ¶added inv1.67.0

type SettingsInternalUpdateOut struct {ColorPaletteDark            *CustomColorPalette    `json:"colorPaletteDark,omitempty"`ColorPaletteLight           *CustomColorPalette    `json:"colorPaletteLight,omitempty"`CustomBaseFontSize          *int64                 `json:"customBaseFontSize,omitempty"`CustomColor                 *string                `json:"customColor,omitempty"`CustomFontFamily            *string                `json:"customFontFamily,omitempty"`CustomFontFamilyUrl         *string                `json:"customFontFamilyUrl,omitempty"`CustomLogoUrl               *string                `json:"customLogoUrl,omitempty"`CustomStringsOverride       *CustomStringsOverride `json:"customStringsOverride,omitempty"`CustomThemeOverride         *CustomThemeOverride   `json:"customThemeOverride,omitempty"`DisableEndpointOnFailure    *bool                  `json:"disableEndpointOnFailure,omitempty"`DisplayName                 *string                `json:"displayName,omitempty"`EnableChannels              *bool                  `json:"enableChannels,omitempty"`EnableEndpointMtlsConfig    *bool                  `json:"enableEndpointMtlsConfig,omitempty"`EnableEndpointOauthConfig   *bool                  `json:"enableEndpointOauthConfig,omitempty"`EnableIntegrationManagement *bool                  `json:"enableIntegrationManagement,omitempty"`EnableMessageStream         *bool                  `json:"enableMessageStream,omitempty"`EnableMsgAtmptLog           *bool                  `json:"enableMsgAtmptLog,omitempty"`EnableOtlp                  *bool                  `json:"enableOtlp,omitempty"`EnableTransformations       *bool                  `json:"enableTransformations,omitempty"`EnforceHttps                *bool                  `json:"enforceHttps,omitempty"`EventCatalogPublished       *bool                  `json:"eventCatalogPublished,omitempty"`ReadOnly                    *bool                  `json:"readOnly,omitempty"`RequireEndpointChannel      *bool                  `json:"requireEndpointChannel,omitempty"`RequireEndpointFilterTypes  *bool                  `json:"requireEndpointFilterTypes,omitempty"`RetryPolicy                 []int32                `json:"retryPolicy,omitempty"`ShowUseSvixPlay             *bool                  `json:"showUseSvixPlay,omitempty"`WhitelabelHeaders           *bool                  `json:"whitelabelHeaders,omitempty"`WipeSuccessfulPayload       *bool                  `json:"wipeSuccessfulPayload,omitempty"`}

typeShopifyConfig ¶added inv1.63.0

type ShopifyConfig struct {Secretstring `json:"secret"`}

typeShopifyConfigOut ¶added inv1.63.0

type ShopifyConfigOut struct {}

typeSlackConfig ¶added inv1.63.0

type SlackConfig struct {Secretstring `json:"secret"`}

typeSlackConfigOut ¶added inv1.63.0

type SlackConfigOut struct {}

typeStatusCodeClass ¶

type StatusCodeClassint64

The different classes of HTTP status codes:- CodeNone = 0- Code1xx = 100- Code2xx = 200- Code3xx = 300- Code4xx = 400- Code5xx = 500

const (STATUSCODECLASS_CODE_NONEStatusCodeClass = 0STATUSCODECLASS_CODE1XXStatusCodeClass = 100STATUSCODECLASS_CODE2XXStatusCodeClass = 200STATUSCODECLASS_CODE3XXStatusCodeClass = 300STATUSCODECLASS_CODE4XXStatusCodeClass = 400STATUSCODECLASS_CODE5XXStatusCodeClass = 500)

func (*StatusCodeClass)UnmarshalJSON ¶

func (v *StatusCodeClass) UnmarshalJSON(src []byte)error

typeStripeConfig ¶added inv1.63.0

type StripeConfig struct {Secretstring `json:"secret"`}

typeStripeConfigOut ¶added inv1.63.0

type StripeConfigOut struct {}

typeSvixConfig ¶added inv1.63.0

type SvixConfig struct {Secretstring `json:"secret"`}

typeSvixConfigOut ¶added inv1.63.0

type SvixConfigOut struct {}

typeZoomConfig ¶added inv1.63.0

type ZoomConfig struct {Secretstring `json:"secret"`}

typeZoomConfigOut ¶added inv1.63.0

type ZoomConfigOut struct {}

Source Files¶

View all Source files

?	: This menu
/	: Search site
f orF	: Jump to
y orY	: Canonical URL

Movatterモバイル変換

Details

Repository

Links

Documentation¶

Overview¶

Package svix this file was hand written¶

Index¶

Constants¶

Variables¶

Functions¶

Types¶

typeAdobeSignConfig¶added inv1.63.0

typeAdobeSignConfigOut¶added inv1.63.0

typeAggregateEventTypesOut¶

typeApiTokenCensoredOut¶added inv1.63.1

typeApiTokenExpireIn¶added inv1.63.1

typeApiTokenIn¶added inv1.63.1

typeApiTokenOut¶added inv1.63.1

typeAppPortalAccessIn¶

typeAppPortalAccessOut¶

typeAppUsageStatsIn¶

typeAppUsageStatsOut¶

typeApplicationIn¶

typeApplicationOut¶

typeApplicationPatch¶

func (ApplicationPatch)MarshalJSON¶

typeApplicationTokenExpireIn¶

typeBackgroundTaskFinishedEvent¶added inv1.63.0

typeBackgroundTaskFinishedEvent2¶added inv1.63.0

typeBackgroundTaskOut¶

typeBackgroundTaskStatus¶

func (*BackgroundTaskStatus)UnmarshalJSON¶

typeBackgroundTaskType¶

func (*BackgroundTaskType)UnmarshalJSON¶

typeBorderRadiusConfig¶added inv1.64.1

typeBorderRadiusEnum¶added inv1.64.1

func (*BorderRadiusEnum)UnmarshalJSON¶added inv1.64.1

typeConnectorIn¶added inv1.58.2

typeConnectorKind¶added inv1.58.2

func (*ConnectorKind)UnmarshalJSON¶added inv1.58.2

typeConnectorOut¶added inv1.63.0

typeCronConfig¶added inv1.63.0

typeCustomColorPalette¶added inv1.64.1

typeCustomStringsOverride¶added inv1.64.1

typeCustomThemeOverride¶added inv1.64.1

typeDashboardAccessOut¶

typeDocusignConfig¶added inv1.63.0

typeDocusignConfigOut¶added inv1.63.0

typeEndpointCreatedEvent¶added inv1.63.0

typeEndpointCreatedEventData¶added inv1.63.0

typeEndpointDeletedEvent¶added inv1.63.0

typeEndpointDeletedEventData¶added inv1.63.0

typeEndpointDisabledEvent¶added inv1.63.0

typeEndpointDisabledEventData¶added inv1.63.0

typeEndpointDisabledTrigger¶added inv1.63.0

func (*EndpointDisabledTrigger)UnmarshalJSON¶added inv1.63.0

typeEndpointEnabledEvent¶added inv1.63.0

typeEndpointEnabledEventData¶added inv1.63.0

typeEndpointHeadersIn¶

typeEndpointHeadersOut¶

typeEndpointHeadersPatchIn¶

typeEndpointIn¶

typeEndpointMessageOut¶

typeEndpointOut¶

typeEndpointPatch¶

func (EndpointPatch)MarshalJSON¶

typeEndpointSecretOut¶

typeEndpointSecretRotateIn¶

typeEndpointStats¶

typeEndpointTransformationIn¶

typeEndpointTransformationOut¶

typeEndpointUpdate¶

typeEndpointUpdatedEvent¶added inv1.63.0

typeEndpointUpdatedEventData¶added inv1.63.0

typeEnvironmentIn¶

typeEnvironmentModelIn¶added inv1.64.1

typeEnvironmentModelOut¶added inv1.64.1

typeEnvironmentModelUpdate¶added inv1.64.1

typeEnvironmentOut¶

Documentation ¶

typeAdobeSignConfig ¶added inv1.63.0

typeAdobeSignConfigOut ¶added inv1.63.0

typeAggregateEventTypesOut ¶

typeApiTokenCensoredOut ¶added inv1.63.1

typeApiTokenExpireIn ¶added inv1.63.1

typeApiTokenIn ¶added inv1.63.1

typeApiTokenOut ¶added inv1.63.1

typeAppPortalAccessIn ¶

typeAppPortalAccessOut ¶

typeAppUsageStatsIn ¶

typeAppUsageStatsOut ¶

typeApplicationIn ¶

typeApplicationOut ¶

typeApplicationPatch ¶

func (ApplicationPatch)MarshalJSON ¶

typeApplicationTokenExpireIn ¶

typeBackgroundTaskFinishedEvent ¶added inv1.63.0

typeBackgroundTaskFinishedEvent2 ¶added inv1.63.0

typeBackgroundTaskOut ¶

typeBackgroundTaskStatus ¶

func (*BackgroundTaskStatus)UnmarshalJSON ¶

typeBackgroundTaskType ¶

func (*BackgroundTaskType)UnmarshalJSON ¶

typeBorderRadiusConfig ¶added inv1.64.1

typeBorderRadiusEnum ¶added inv1.64.1

func (*BorderRadiusEnum)UnmarshalJSON ¶added inv1.64.1

typeConnectorIn ¶added inv1.58.2

typeConnectorKind ¶added inv1.58.2

func (*ConnectorKind)UnmarshalJSON ¶added inv1.58.2

typeConnectorOut ¶added inv1.63.0

typeCronConfig ¶added inv1.63.0

typeCustomColorPalette ¶added inv1.64.1

typeCustomStringsOverride ¶added inv1.64.1

typeCustomThemeOverride ¶added inv1.64.1

typeDashboardAccessOut ¶

typeDocusignConfig ¶added inv1.63.0

typeDocusignConfigOut ¶added inv1.63.0

typeEndpointCreatedEvent ¶added inv1.63.0

typeEndpointCreatedEventData ¶added inv1.63.0

typeEndpointDeletedEvent ¶added inv1.63.0

typeEndpointDeletedEventData ¶added inv1.63.0

typeEndpointDisabledEvent ¶added inv1.63.0

typeEndpointDisabledEventData ¶added inv1.63.0

typeEndpointDisabledTrigger ¶added inv1.63.0

func (*EndpointDisabledTrigger)UnmarshalJSON ¶added inv1.63.0

typeEndpointEnabledEvent ¶added inv1.63.0

typeEndpointEnabledEventData ¶added inv1.63.0

typeEndpointHeadersIn ¶

typeEndpointHeadersOut ¶

typeEndpointHeadersPatchIn ¶

typeEndpointIn ¶

typeEndpointMessageOut ¶

typeEndpointOut ¶

typeEndpointPatch ¶

func (EndpointPatch)MarshalJSON ¶

typeEndpointSecretOut ¶

typeEndpointSecretRotateIn ¶

typeEndpointStats ¶

typeEndpointTransformationIn ¶

typeEndpointTransformationOut ¶

typeEndpointUpdate ¶

typeEndpointUpdatedEvent ¶added inv1.63.0

typeEndpointUpdatedEventData ¶added inv1.63.0

typeEnvironmentIn ¶

typeEnvironmentModelIn ¶added inv1.64.1

typeEnvironmentModelOut ¶added inv1.64.1

typeEnvironmentModelUpdate ¶added inv1.64.1

typeEnvironmentOut ¶

typeEnvironmentRegion ¶added inv1.64.1

func (*EnvironmentRegion)UnmarshalJSON ¶added inv1.64.1

typeEnvironmentType ¶added inv1.64.1

func (*EnvironmentType)UnmarshalJSON ¶added inv1.64.1

typeEventExampleIn ¶

typeEventTypeFromOpenApi ¶

typeEventTypeImportOpenApiIn ¶

typeEventTypeImportOpenApiOut ¶

typeEventTypeImportOpenApiOutData ¶

typeEventTypeIn ¶

typeEventTypeOut ¶