Documentation
¶
Overview ¶
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
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
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Package svix this file is @generated DO NOT EDIT
Index ¶
- Variables
- type AdobeSignConfig
- type AdobeSignConfigOut
- type AggregateEventTypesOut
- type ApiTokenCensoredOut
- type ApiTokenExpireIn
- type ApiTokenIn
- type ApiTokenOut
- type AppPortalAccessIn
- type AppPortalAccessOut
- type AppUsageStatsIn
- type AppUsageStatsOut
- type ApplicationIn
- type ApplicationOut
- type ApplicationPatch
- type ApplicationTokenExpireIn
- type BackgroundTaskFinishedEvent
- type BackgroundTaskFinishedEvent2
- type BackgroundTaskOut
- type BackgroundTaskStatus
- type BackgroundTaskType
- type ConnectorIn
- type ConnectorKind
- type ConnectorOut
- type CronConfig
- type DashboardAccessOut
- type DocusignConfig
- type DocusignConfigOut
- type EndpointCreatedEvent
- type EndpointCreatedEventData
- type EndpointDeletedEvent
- type EndpointDeletedEventData
- type EndpointDisabledEvent
- type EndpointDisabledEventData
- type EndpointDisabledTrigger
- type EndpointEnabledEvent
- type EndpointEnabledEventData
- type EndpointHeadersIn
- type EndpointHeadersOut
- type EndpointHeadersPatchIn
- type EndpointIn
- type EndpointMessageOut
- type EndpointOut
- type EndpointPatch
- type EndpointSecretOut
- type EndpointSecretRotateIn
- type EndpointStats
- type EndpointTransformationIn
- type EndpointTransformationOut
- type EndpointUpdate
- type EndpointUpdatedEvent
- type EndpointUpdatedEventData
- type EnvironmentIn
- type EnvironmentOut
- type EventExampleIn
- type EventTypeFromOpenApi
- type EventTypeImportOpenApiIn
- type EventTypeImportOpenApiOut
- type EventTypeImportOpenApiOutData
- type EventTypeIn
- type EventTypeOut
- type EventTypePatch
- type EventTypeUpdate
- type ExpungAllContentsOut
- type ExpungeAllContentsOut
- type GithubConfig
- type GithubConfigOut
- type HubspotConfig
- type HubspotConfigOut
- type IngestEndpointHeadersIn
- type IngestEndpointHeadersOut
- type IngestEndpointIn
- type IngestEndpointOut
- type IngestEndpointSecretIn
- type IngestEndpointSecretOut
- type IngestEndpointUpdate
- type IngestSourceConsumerPortalAccessIn
- type IngestSourceIn
- type IngestSourceInConfig
- type IngestSourceInType
- type IngestSourceOut
- type IngestSourceOutConfig
- type IngestSourceOutType
- type IntegrationIn
- type IntegrationKeyOut
- type IntegrationOut
- type IntegrationUpdate
- type ListResponseApiTokenCensoredOut
- type ListResponseApplicationOut
- type ListResponseBackgroundTaskOut
- type ListResponseEndpointMessageOut
- type ListResponseEndpointOut
- type ListResponseEventTypeOut
- type ListResponseIngestEndpointOut
- type ListResponseIngestSourceOut
- type ListResponseIntegrationOut
- type ListResponseMessageAttemptOut
- type ListResponseMessageEndpointOut
- type ListResponseMessageOut
- type ListResponseOperationalWebhookEndpointOut
- type MessageAttemptExhaustedEvent
- type MessageAttemptExhaustedEventData
- type MessageAttemptFailedData
- type MessageAttemptFailingEvent
- type MessageAttemptFailingEventData
- type MessageAttemptOut
- type MessageAttemptRecoveredEvent
- type MessageAttemptRecoveredEventData
- type MessageAttemptTriggerType
- type MessageEndpointOut
- type MessageIn
- type MessageOut
- type MessageStatus
- type OperationalWebhookEndpointHeadersIn
- type OperationalWebhookEndpointHeadersOut
- type OperationalWebhookEndpointIn
- type OperationalWebhookEndpointOut
- type OperationalWebhookEndpointSecretIn
- type OperationalWebhookEndpointSecretOut
- type OperationalWebhookEndpointUpdate
- type Ordering
- type PollingEndpointConsumerSeekIn
- type PollingEndpointConsumerSeekOut
- type PollingEndpointMessageOut
- type PollingEndpointOut
- type RecoverIn
- type RecoverOut
- type ReplayIn
- type ReplayOut
- type RotateTokenOut
- type SegmentConfig
- type SegmentConfigOut
- type ShopifyConfig
- type ShopifyConfigOut
- type SlackConfig
- type SlackConfigOut
- type StatusCodeClass
- type StripeConfig
- type StripeConfigOut
- type SvixConfig
- type SvixConfigOut
- type TemplateOut
- type TransformationTemplateKind
- type ZoomConfig
- type ZoomConfigOut
Constants ¶
This section is empty.
Variables ¶
var IngestSourceInTypeWithNoConfig = map[string]bool{ "generic-webhook": true, }
var IngestSourceOutTypeWithNoConfig = map[string]bool{ "generic-webhook": true, }
Functions ¶
This section is empty.
Types ¶
type AdobeSignConfig ¶ added in v1.63.0
type AdobeSignConfig struct {
ClientId string `json:"clientId"`
}
type AdobeSignConfigOut ¶ added in v1.63.0
type AdobeSignConfigOut struct {
}
type AggregateEventTypesOut ¶
type AggregateEventTypesOut struct {
Id string `json:"id"` // The QueueBackgroundTask's ID.
Status BackgroundTaskStatus `json:"status"`
Task BackgroundTaskType `json:"task"`
}
type ApiTokenCensoredOut ¶ added in v1.63.1
type ApiTokenExpireIn ¶ added in v1.63.1
type ApiTokenExpireIn struct {
Expiry *int32 `json:"expiry,omitempty"` // How many seconds until the old key is expired.
}
type ApiTokenIn ¶ added in v1.63.1
type ApiTokenOut ¶ added in v1.63.1
type AppPortalAccessIn ¶
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.
}
type AppPortalAccessOut ¶
type AppUsageStatsIn ¶
type AppUsageStatsOut ¶
type AppUsageStatsOut struct {
Id string `json:"id"` // The QueueBackgroundTask's ID.
Status BackgroundTaskStatus `json:"status"`
Task BackgroundTaskType `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"`
}
type ApplicationIn ¶
type ApplicationOut ¶
type ApplicationOut struct {
CreatedAt time.Time `json:"createdAt"`
Id string `json:"id"` // The Application's ID.
Metadata map[string]string `json:"metadata"`
Name string `json:"name"`
RateLimit *uint16 `json:"rateLimit,omitempty"`
Uid *string `json:"uid,omitempty"` // The Application's UID.
UpdatedAt time.Time `json:"updatedAt"`
}
type ApplicationPatch ¶
type ApplicationPatch struct {
Metadata *map[string]string `json:"metadata,omitempty"`
Name *string `json:"name,omitempty"`
RateLimit utils.Nullable[uint16] `json:"rateLimit"`
Uid utils.Nullable[string] `json:"uid"` // The Application's UID.
}
func (ApplicationPatch) MarshalJSON ¶
func (o ApplicationPatch) MarshalJSON() ([]byte, error)
type ApplicationTokenExpireIn ¶
type ApplicationTokenExpireIn struct {
Expiry *int64 `json:"expiry,omitempty"` // How many seconds until the old key is expired.
}
type BackgroundTaskFinishedEvent ¶ added in v1.63.0
type BackgroundTaskFinishedEvent struct {
Data BackgroundTaskFinishedEvent2 `json:"data"`
Type string `json:"type"`
}
Sent when a background task is finished.
type BackgroundTaskFinishedEvent2 ¶ added in v1.63.0
type BackgroundTaskFinishedEvent2 struct {
Data map[string]any `json:"data"`
Status BackgroundTaskStatus `json:"status"`
Task BackgroundTaskType `json:"task"`
TaskId string `json:"taskId"` // The QueueBackgroundTask's ID.
}
type BackgroundTaskOut ¶
type BackgroundTaskOut struct {
Data map[string]any `json:"data"`
Id string `json:"id"` // The QueueBackgroundTask's ID.
Status BackgroundTaskStatus `json:"status"`
Task BackgroundTaskType `json:"task"`
}
type BackgroundTaskStatus ¶
type BackgroundTaskStatus string
const ( BACKGROUNDTASKSTATUS_RUNNING BackgroundTaskStatus = "running" BACKGROUNDTASKSTATUS_FINISHED BackgroundTaskStatus = "finished" BACKGROUNDTASKSTATUS_FAILED BackgroundTaskStatus = "failed" )
func (*BackgroundTaskStatus) UnmarshalJSON ¶
func (v *BackgroundTaskStatus) UnmarshalJSON(src []byte) error
type BackgroundTaskType ¶
type BackgroundTaskType string
const ( BACKGROUNDTASKTYPE_ENDPOINT_REPLAY BackgroundTaskType = "endpoint.replay" BACKGROUNDTASKTYPE_ENDPOINT_RECOVER BackgroundTaskType = "endpoint.recover" BACKGROUNDTASKTYPE_APPLICATION_STATS BackgroundTaskType = "application.stats" BACKGROUNDTASKTYPE_MESSAGE_BROADCAST BackgroundTaskType = "message.broadcast" BACKGROUNDTASKTYPE_SDK_GENERATE BackgroundTaskType = "sdk.generate" BACKGROUNDTASKTYPE_EVENT_TYPE_AGGREGATE BackgroundTaskType = "event-type.aggregate" BACKGROUNDTASKTYPE_APPLICATION_PURGE_CONTENT BackgroundTaskType = "application.purge_content" )
func (*BackgroundTaskType) UnmarshalJSON ¶
func (v *BackgroundTaskType) UnmarshalJSON(src []byte) error
type ConnectorIn ¶ added in v1.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"`
Logo string `json:"logo"`
Name string `json:"name"`
Transformation string `json:"transformation"`
}
type ConnectorKind ¶ added in v1.58.2
type ConnectorKind string
const ( CONNECTORKIND_CUSTOM ConnectorKind = "Custom" CONNECTORKIND_CUSTOMER_IO ConnectorKind = "CustomerIO" CONNECTORKIND_DISCORD ConnectorKind = "Discord" CONNECTORKIND_HUBSPOT ConnectorKind = "Hubspot" CONNECTORKIND_INNGEST ConnectorKind = "Inngest" CONNECTORKIND_SALESFORCE ConnectorKind = "Salesforce" CONNECTORKIND_SEGMENT ConnectorKind = "Segment" CONNECTORKIND_SLACK ConnectorKind = "Slack" CONNECTORKIND_TEAMS ConnectorKind = "Teams" CONNECTORKIND_TRIGGER_DEV ConnectorKind = "TriggerDev" CONNECTORKIND_WINDMILL ConnectorKind = "Windmill" CONNECTORKIND_ZAPIER ConnectorKind = "Zapier" )
func (*ConnectorKind) UnmarshalJSON ¶ added in v1.58.2
func (v *ConnectorKind) UnmarshalJSON(src []byte) error
type ConnectorOut ¶ added in v1.63.0
type ConnectorOut struct {
CreatedAt time.Time `json:"createdAt"`
Description string `json:"description"`
FeatureFlag *string `json:"featureFlag,omitempty"`
FilterTypes []string `json:"filterTypes,omitempty"`
Id string `json:"id"` // The TransformationTemplate's ID.
Instructions string `json:"instructions"`
InstructionsLink *string `json:"instructionsLink,omitempty"`
Kind ConnectorKind `json:"kind"`
Logo string `json:"logo"`
Name string `json:"name"`
OrgId string `json:"orgId"` // The Organization's ID.
Transformation string `json:"transformation"`
UpdatedAt time.Time `json:"updatedAt"`
}
type CronConfig ¶ added in v1.63.0
type DashboardAccessOut ¶
type DocusignConfig ¶ added in v1.63.0
type DocusignConfig struct {
Secret *string `json:"secret,omitempty"`
}
type DocusignConfigOut ¶ added in v1.63.0
type DocusignConfigOut struct {
}
type EndpointCreatedEvent ¶ added in v1.63.0
type EndpointCreatedEvent struct {
Data EndpointCreatedEventData `json:"data"`
Type string `json:"type"`
}
Sent when an endpoint is created.
type EndpointCreatedEventData ¶ added in v1.63.0
type EndpointCreatedEventData struct {
AppId string `json:"appId"` // The Application's ID.
AppUid *string `json:"appUid,omitempty"` // The Application's UID.
EndpointId string `json:"endpointId"` // The Endpoint's ID.
EndpointUid *string `json:"endpointUid,omitempty"` // The Endpoint's UID.
}
Sent when an endpoint is created, updated, or deleted
type EndpointDeletedEvent ¶ added in v1.63.0
type EndpointDeletedEvent struct {
Data EndpointDeletedEventData `json:"data"`
Type string `json:"type"`
}
Sent when an endpoint is deleted.
type EndpointDeletedEventData ¶ added in v1.63.0
type EndpointDeletedEventData struct {
AppId string `json:"appId"` // The Application's ID.
AppUid *string `json:"appUid,omitempty"` // The Application's UID.
EndpointId string `json:"endpointId"` // The Endpoint's ID.
EndpointUid *string `json:"endpointUid,omitempty"` // The Endpoint's UID.
}
Sent when an endpoint is created, updated, or deleted
type EndpointDisabledEvent ¶ added in v1.63.0
type EndpointDisabledEvent struct {
Data EndpointDisabledEventData `json:"data"`
Type string `json:"type"`
}
Sent when an endpoint has been automatically disabled after continuous failures, or manually via an API call.
type EndpointDisabledEventData ¶ added in v1.63.0
type EndpointDisabledEventData struct {
AppId string `json:"appId"` // The Application's ID.
AppUid *string `json:"appUid,omitempty"` // The Application's UID.
EndpointId string `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.
type EndpointDisabledTrigger ¶ added in v1.63.0
type EndpointDisabledTrigger string
const ( ENDPOINTDISABLEDTRIGGER_MANUAL EndpointDisabledTrigger = "manual" ENDPOINTDISABLEDTRIGGER_AUTOMATIC EndpointDisabledTrigger = "automatic" )
func (*EndpointDisabledTrigger) UnmarshalJSON ¶ added in v1.63.0
func (v *EndpointDisabledTrigger) UnmarshalJSON(src []byte) error
type EndpointEnabledEvent ¶ added in v1.63.0
type EndpointEnabledEvent struct {
Data EndpointEnabledEventData `json:"data"`
Type string `json:"type"`
}
Sent when an endpoint has been enabled.
type EndpointEnabledEventData ¶ added in v1.63.0
type EndpointEnabledEventData struct {
AppId string `json:"appId"` // The Application's ID.
AppUid *string `json:"appUid,omitempty"` // The Application's UID.
EndpointId string `json:"endpointId"` // The Endpoint's ID.
EndpointUid *string `json:"endpointUid,omitempty"` // The Endpoint's UID.
}
Sent when an endpoint has been enabled.
type EndpointHeadersIn ¶
type EndpointHeadersOut ¶
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.
type EndpointHeadersPatchIn ¶
type EndpointIn ¶
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.
Url string `json:"url"`
Version *uint16 `json:"version,omitempty"`
}
type EndpointMessageOut ¶
type EndpointMessageOut struct {
Channels []string `json:"channels,omitempty"` // List of free-form identifiers that endpoints can filter by
EventId *string `json:"eventId,omitempty"` // Optional unique identifier for the message
EventType string `json:"eventType"` // The event type's name
Id string `json:"id"` // The Message's ID.
NextAttempt *time.Time `json:"nextAttempt,omitempty"`
Payload map[string]any `json:"payload"`
Status MessageStatus `json:"status"`
Tags []string `json:"tags,omitempty"`
Timestamp time.Time `json:"timestamp"`
}
A model containing information on a given message plus additional fields on the last attempt for that message.
type EndpointOut ¶
type EndpointOut struct {
Channels []string `json:"channels,omitempty"` // List of message channels this endpoint listens to (omit for all).
CreatedAt time.Time `json:"createdAt"`
Description string `json:"description"` // An example endpoint name.
Disabled *bool `json:"disabled,omitempty"`
FilterTypes []string `json:"filterTypes,omitempty"`
Id string `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.
UpdatedAt time.Time `json:"updatedAt"`
Url string `json:"url"`
Version int32 `json:"version"`
}
type EndpointPatch ¶
type EndpointPatch struct {
Channels utils.Nullable[[]string] `json:"channels"`
Description *string `json:"description,omitempty"`
Disabled *bool `json:"disabled,omitempty"`
FilterTypes utils.Nullable[[]string] `json:"filterTypes"`
Metadata *map[string]string `json:"metadata,omitempty"`
RateLimit utils.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.
Secret utils.Nullable[string] `json:"secret"`
Uid utils.Nullable[string] `json:"uid"` // The Endpoint's UID.
Url *string `json:"url,omitempty"`
Version *uint16 `json:"version,omitempty"`
}
func (EndpointPatch) MarshalJSON ¶
func (o EndpointPatch) MarshalJSON() ([]byte, error)
type EndpointSecretOut ¶
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.
Key string `json:"key"`
}
type EndpointSecretRotateIn ¶
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"`
}
type EndpointStats ¶
type EndpointUpdate ¶
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.
Url string `json:"url"`
Version *uint16 `json:"version,omitempty"`
}
type EndpointUpdatedEvent ¶ added in v1.63.0
type EndpointUpdatedEvent struct {
Data EndpointUpdatedEventData `json:"data"`
Type string `json:"type"`
}
Sent when an endpoint is updated.
type EndpointUpdatedEventData ¶ added in v1.63.0
type EndpointUpdatedEventData struct {
AppId string `json:"appId"` // The Application's ID.
AppUid *string `json:"appUid,omitempty"` // The Application's UID.
EndpointId string `json:"endpointId"` // The Endpoint's ID.
EndpointUid *string `json:"endpointUid,omitempty"` // The Endpoint's UID.
}
Sent when an endpoint is created, updated, or deleted
type EnvironmentIn ¶
type EnvironmentIn struct {
Connectors []ConnectorIn `json:"connectors,omitempty"`
EventTypes []EventTypeIn `json:"eventTypes,omitempty"`
Settings *map[string]any `json:"settings,omitempty"`
}
type EnvironmentOut ¶
type EnvironmentOut struct {
CreatedAt time.Time `json:"createdAt"`
EventTypes []EventTypeOut `json:"eventTypes"`
Settings *map[string]any `json:"settings,omitempty"`
TransformationTemplates []ConnectorOut `json:"transformationTemplates"`
Version *int64 `json:"version,omitempty"`
}
type EventExampleIn ¶
type EventExampleIn struct {
EventType string `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"`
}
type EventTypeFromOpenApi ¶
type EventTypeFromOpenApi struct {
Deprecated bool `json:"deprecated"`
Description string `json:"description"`
FeatureFlag *string `json:"featureFlag,omitempty"`
GroupName *string `json:"groupName,omitempty"` // The event type group's name
Name string `json:"name"` // The event type's name
Schemas *map[string]any `json:"schemas,omitempty"`
}
type EventTypeImportOpenApiIn ¶
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**.
type EventTypeImportOpenApiOut ¶
type EventTypeImportOpenApiOut struct {
Data EventTypeImportOpenApiOutData `json:"data"`
}
type EventTypeImportOpenApiOutData ¶
type EventTypeImportOpenApiOutData struct {
Modified []string `json:"modified"`
ToModify []EventTypeFromOpenApi `json:"to_modify,omitempty"`
}
type EventTypeIn ¶
type EventTypeIn struct {
Archived *bool `json:"archived,omitempty"`
Deprecated *bool `json:"deprecated,omitempty"`
Description string `json:"description"`
FeatureFlag *string `json:"featureFlag,omitempty"`
GroupName *string `json:"groupName,omitempty"` // The event type group's name
Name string `json:"name"` // The event type's name
Schemas *map[string]any `json:"schemas,omitempty"` // The schema for the event type for a specific version as a JSON schema.
}
type EventTypeOut ¶
type EventTypeOut struct {
Archived *bool `json:"archived,omitempty"`
CreatedAt time.Time `json:"createdAt"`
Deprecated bool `json:"deprecated"`
Description string `json:"description"`
FeatureFlag *string `json:"featureFlag,omitempty"`
GroupName *string `json:"groupName,omitempty"` // The event type group's name
Name string `json:"name"` // The event type's name
Schemas *map[string]any `json:"schemas,omitempty"` // The schema for the event type for a specific version as a JSON schema.
UpdatedAt time.Time `json:"updatedAt"`
}
type EventTypePatch ¶
type EventTypePatch struct {
Archived *bool `json:"archived,omitempty"`
Deprecated *bool `json:"deprecated,omitempty"`
Description *string `json:"description,omitempty"`
FeatureFlag utils.Nullable[string] `json:"featureFlag"`
GroupName utils.Nullable[string] `json:"groupName"` // The event type group's name
Schemas utils.Nullable[map[string]any] `json:"schemas"`
}
func (EventTypePatch) MarshalJSON ¶
func (o EventTypePatch) MarshalJSON() ([]byte, error)
type EventTypeUpdate ¶
type EventTypeUpdate struct {
Archived *bool `json:"archived,omitempty"`
Deprecated *bool `json:"deprecated,omitempty"`
Description string `json:"description"`
FeatureFlag *string `json:"featureFlag,omitempty"`
GroupName *string `json:"groupName,omitempty"` // The event type group's name
Schemas *map[string]any `json:"schemas,omitempty"` // The schema for the event type for a specific version as a JSON schema.
}
type ExpungAllContentsOut ¶ added in v1.58.2
type ExpungAllContentsOut struct {
Id string `json:"id"` // The QueueBackgroundTask's ID.
Status BackgroundTaskStatus `json:"status"`
Task BackgroundTaskType `json:"task"`
}
type ExpungeAllContentsOut ¶ added in v1.61.1
type ExpungeAllContentsOut struct {
Id string `json:"id"` // The QueueBackgroundTask's ID.
Status BackgroundTaskStatus `json:"status"`
Task BackgroundTaskType `json:"task"`
}
type GithubConfig ¶ added in v1.63.0
type GithubConfig struct {
Secret *string `json:"secret,omitempty"`
}
type GithubConfigOut ¶ added in v1.63.0
type GithubConfigOut struct {
}
type HubspotConfig ¶ added in v1.63.0
type HubspotConfig struct {
Secret *string `json:"secret,omitempty"`
}
type HubspotConfigOut ¶ added in v1.63.0
type HubspotConfigOut struct {
}
type IngestEndpointHeadersIn ¶ added in v1.61.1
type IngestEndpointHeadersOut ¶ added in v1.61.1
type IngestEndpointIn ¶ added in v1.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.
Url string `json:"url"`
}
type IngestEndpointOut ¶ added in v1.61.1
type IngestEndpointOut struct {
CreatedAt time.Time `json:"createdAt"`
Description string `json:"description"` // An example endpoint name.
Disabled *bool `json:"disabled,omitempty"`
Id string `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.
UpdatedAt time.Time `json:"updatedAt"`
Url string `json:"url"`
}
type IngestEndpointSecretIn ¶ added in v1.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"`
}
type IngestEndpointSecretOut ¶ added in v1.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.
Key string `json:"key"`
}
type IngestEndpointUpdate ¶ added in v1.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.
Url string `json:"url"`
}
type IngestSourceConsumerPortalAccessIn ¶ added in v1.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.
}
type IngestSourceIn ¶ added in v1.63.0
type IngestSourceIn struct {
Name string `json:"name"`
Uid *string `json:"uid,omitempty"` // The Source's UID.
Type IngestSourceInType `json:"type"`
Config IngestSourceInConfig `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
- "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 in v1.63.0
func (i IngestSourceIn) MarshalJSON() ([]byte, error)
func (*IngestSourceIn) UnmarshalJSON ¶ added in v1.63.0
func (i *IngestSourceIn) UnmarshalJSON(data []byte) error
type IngestSourceInConfig ¶ added in v1.63.0
type IngestSourceInConfig interface {
// contains filtered or unexported methods
}
type IngestSourceInType ¶ added in v1.63.0
type IngestSourceInType string
const ( IngestSourceInTypeGenericWebhook IngestSourceInType = "generic-webhook" IngestSourceInTypeCron IngestSourceInType = "cron" IngestSourceInTypeAdobeSign IngestSourceInType = "adobe-sign" IngestSourceInTypeBeehiiv IngestSourceInType = "beehiiv" IngestSourceInTypeBrex IngestSourceInType = "brex" IngestSourceInTypeClerk IngestSourceInType = "clerk" IngestSourceInTypeDocusign IngestSourceInType = "docusign" IngestSourceInTypeGithub IngestSourceInType = "github" IngestSourceInTypeGuesty IngestSourceInType = "guesty" IngestSourceInTypeHubspot IngestSourceInType = "hubspot" IngestSourceInTypeIncidentIo IngestSourceInType = "incident-io" IngestSourceInTypeLithic IngestSourceInType = "lithic" IngestSourceInTypeNash IngestSourceInType = "nash" IngestSourceInTypePleo IngestSourceInType = "pleo" IngestSourceInTypeReplicate IngestSourceInType = "replicate" IngestSourceInTypeResend IngestSourceInType = "resend" IngestSourceInTypeSafebase IngestSourceInType = "safebase" IngestSourceInTypeSardine IngestSourceInType = "sardine" IngestSourceInTypeSegment IngestSourceInType = "segment" IngestSourceInTypeShopify IngestSourceInType = "shopify" IngestSourceInTypeSlack IngestSourceInType = "slack" IngestSourceInTypeStripe IngestSourceInType = "stripe" IngestSourceInTypeStych IngestSourceInType = "stych" IngestSourceInTypeSvix IngestSourceInType = "svix" IngestSourceInTypeZoom IngestSourceInType = "zoom" )
type IngestSourceOut ¶ added in v1.63.0
type IngestSourceOut struct {
CreatedAt time.Time `json:"createdAt"`
Id string `json:"id"` // The Source's ID.
IngestUrl *string `json:"ingestUrl,omitempty"`
Name string `json:"name"`
Uid *string `json:"uid,omitempty"` // The Source's UID.
UpdatedAt time.Time `json:"updatedAt"`
Type IngestSourceOutType `json:"type"`
Config IngestSourceOutConfig `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
- "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 in v1.63.0
func (i IngestSourceOut) MarshalJSON() ([]byte, error)
func (*IngestSourceOut) UnmarshalJSON ¶ added in v1.63.0
func (i *IngestSourceOut) UnmarshalJSON(data []byte) error
type IngestSourceOutConfig ¶ added in v1.63.0
type IngestSourceOutConfig interface {
// contains filtered or unexported methods
}
type IngestSourceOutType ¶ added in v1.63.0
type IngestSourceOutType string
const ( IngestSourceOutTypeGenericWebhook IngestSourceOutType = "generic-webhook" IngestSourceOutTypeCron IngestSourceOutType = "cron" IngestSourceOutTypeAdobeSign IngestSourceOutType = "adobe-sign" IngestSourceOutTypeBeehiiv IngestSourceOutType = "beehiiv" IngestSourceOutTypeBrex IngestSourceOutType = "brex" IngestSourceOutTypeClerk IngestSourceOutType = "clerk" IngestSourceOutTypeDocusign IngestSourceOutType = "docusign" IngestSourceOutTypeGithub IngestSourceOutType = "github" IngestSourceOutTypeGuesty IngestSourceOutType = "guesty" IngestSourceOutTypeHubspot IngestSourceOutType = "hubspot" IngestSourceOutTypeIncidentIo IngestSourceOutType = "incident-io" IngestSourceOutTypeLithic IngestSourceOutType = "lithic" IngestSourceOutTypeNash IngestSourceOutType = "nash" IngestSourceOutTypePleo IngestSourceOutType = "pleo" IngestSourceOutTypeReplicate IngestSourceOutType = "replicate" IngestSourceOutTypeResend IngestSourceOutType = "resend" IngestSourceOutTypeSafebase IngestSourceOutType = "safebase" IngestSourceOutTypeSardine IngestSourceOutType = "sardine" IngestSourceOutTypeSegment IngestSourceOutType = "segment" IngestSourceOutTypeShopify IngestSourceOutType = "shopify" IngestSourceOutTypeSlack IngestSourceOutType = "slack" IngestSourceOutTypeStripe IngestSourceOutType = "stripe" IngestSourceOutTypeStych IngestSourceOutType = "stych" IngestSourceOutTypeSvix IngestSourceOutType = "svix" IngestSourceOutTypeZoom IngestSourceOutType = "zoom" )
type IntegrationIn ¶
type IntegrationKeyOut ¶
type IntegrationKeyOut struct {
Key string `json:"key"`
}
type IntegrationOut ¶
type IntegrationUpdate ¶
type ListResponseApiTokenCensoredOut ¶ added in v1.63.1
type ListResponseApiTokenCensoredOut struct {
Data []ApiTokenCensoredOut `json:"data"`
Done bool `json:"done"`
Iterator *string `json:"iterator,omitempty"`
PrevIterator *string `json:"prevIterator,omitempty"`
}
type ListResponseApplicationOut ¶
type ListResponseApplicationOut struct {
Data []ApplicationOut `json:"data"`
Done bool `json:"done"`
Iterator *string `json:"iterator,omitempty"`
PrevIterator *string `json:"prevIterator,omitempty"`
}
type ListResponseBackgroundTaskOut ¶
type ListResponseBackgroundTaskOut struct {
Data []BackgroundTaskOut `json:"data"`
Done bool `json:"done"`
Iterator *string `json:"iterator,omitempty"`
PrevIterator *string `json:"prevIterator,omitempty"`
}
type ListResponseEndpointMessageOut ¶
type ListResponseEndpointMessageOut struct {
Data []EndpointMessageOut `json:"data"`
Done bool `json:"done"`
Iterator *string `json:"iterator,omitempty"`
PrevIterator *string `json:"prevIterator,omitempty"`
}
type ListResponseEndpointOut ¶
type ListResponseEndpointOut struct {
Data []EndpointOut `json:"data"`
Done bool `json:"done"`
Iterator *string `json:"iterator,omitempty"`
PrevIterator *string `json:"prevIterator,omitempty"`
}
type ListResponseEventTypeOut ¶
type ListResponseEventTypeOut struct {
Data []EventTypeOut `json:"data"`
Done bool `json:"done"`
Iterator *string `json:"iterator,omitempty"`
PrevIterator *string `json:"prevIterator,omitempty"`
}
type ListResponseIngestEndpointOut ¶ added in v1.61.1
type ListResponseIngestEndpointOut struct {
Data []IngestEndpointOut `json:"data"`
Done bool `json:"done"`
Iterator *string `json:"iterator,omitempty"`
PrevIterator *string `json:"prevIterator,omitempty"`
}
type ListResponseIngestSourceOut ¶ added in v1.63.0
type ListResponseIngestSourceOut struct {
Data []IngestSourceOut `json:"data"`
Done bool `json:"done"`
Iterator *string `json:"iterator,omitempty"`
PrevIterator *string `json:"prevIterator,omitempty"`
}
type ListResponseIntegrationOut ¶
type ListResponseIntegrationOut struct {
Data []IntegrationOut `json:"data"`
Done bool `json:"done"`
Iterator *string `json:"iterator,omitempty"`
PrevIterator *string `json:"prevIterator,omitempty"`
}
type ListResponseMessageAttemptOut ¶
type ListResponseMessageAttemptOut struct {
Data []MessageAttemptOut `json:"data"`
Done bool `json:"done"`
Iterator *string `json:"iterator,omitempty"`
PrevIterator *string `json:"prevIterator,omitempty"`
}
type ListResponseMessageEndpointOut ¶
type ListResponseMessageEndpointOut struct {
Data []MessageEndpointOut `json:"data"`
Done bool `json:"done"`
Iterator *string `json:"iterator,omitempty"`
PrevIterator *string `json:"prevIterator,omitempty"`
}
type ListResponseMessageOut ¶
type ListResponseMessageOut struct {
Data []MessageOut `json:"data"`
Done bool `json:"done"`
Iterator *string `json:"iterator,omitempty"`
PrevIterator *string `json:"prevIterator,omitempty"`
}
type ListResponseOperationalWebhookEndpointOut ¶
type ListResponseOperationalWebhookEndpointOut struct {
Data []OperationalWebhookEndpointOut `json:"data"`
Done bool `json:"done"`
Iterator *string `json:"iterator,omitempty"`
PrevIterator *string `json:"prevIterator,omitempty"`
}
type MessageAttemptExhaustedEvent ¶ added in v1.63.0
type MessageAttemptExhaustedEvent struct {
Data MessageAttemptExhaustedEventData `json:"data"`
Type string `json:"type"`
}
Sent when a message delivery has failed (all of the retry attempts have been exhausted).
type MessageAttemptExhaustedEventData ¶ added in v1.63.0
type MessageAttemptExhaustedEventData struct {
AppId string `json:"appId"` // The Application's ID.
AppUid *string `json:"appUid,omitempty"` // The Application's UID.
EndpointId string `json:"endpointId"` // The Endpoint's ID.
LastAttempt MessageAttemptFailedData `json:"lastAttempt"`
MsgEventId *string `json:"msgEventId,omitempty"` // The Message's UID.
MsgId string `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.
type MessageAttemptFailedData ¶ added in v1.63.0
type MessageAttemptFailingEvent ¶ added in v1.63.0
type MessageAttemptFailingEvent struct {
Data MessageAttemptFailingEventData `json:"data"`
Type string `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.
type MessageAttemptFailingEventData ¶ added in v1.63.0
type MessageAttemptFailingEventData struct {
AppId string `json:"appId"` // The Application's ID.
AppUid *string `json:"appUid,omitempty"` // The Application's UID.
EndpointId string `json:"endpointId"` // The Endpoint's ID.
LastAttempt MessageAttemptFailedData `json:"lastAttempt"`
MsgEventId *string `json:"msgEventId,omitempty"` // The Message's UID.
MsgId string `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.
type MessageAttemptOut ¶
type MessageAttemptOut struct {
EndpointId string `json:"endpointId"` // The Endpoint's ID.
Id string `json:"id"` // The MessageAttempt's ID.
Msg *MessageOut `json:"msg,omitempty"`
MsgId string `json:"msgId"` // The Message's ID.
Response string `json:"response"`
ResponseDurationMs int64 `json:"responseDurationMs"` // Response duration in milliseconds.
ResponseStatusCode int16 `json:"responseStatusCode"`
Status MessageStatus `json:"status"`
Timestamp time.Time `json:"timestamp"`
TriggerType MessageAttemptTriggerType `json:"triggerType"`
Url string `json:"url"`
}
type MessageAttemptRecoveredEvent ¶ added in v1.63.0
type MessageAttemptRecoveredEvent struct {
Data MessageAttemptRecoveredEventData `json:"data"`
Type string `json:"type"`
}
Sent on a successful dispatch after an earlier failure op webhook has already been sent.
type MessageAttemptRecoveredEventData ¶ added in v1.63.0
type MessageAttemptRecoveredEventData struct {
AppId string `json:"appId"` // The Application's ID.
AppUid *string `json:"appUid,omitempty"` // The Application's UID.
EndpointId string `json:"endpointId"` // The Endpoint's ID.
LastAttempt MessageAttemptFailedData `json:"lastAttempt"`
MsgEventId *string `json:"msgEventId,omitempty"` // The Message's UID.
MsgId string `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.
type MessageAttemptTriggerType ¶
type MessageAttemptTriggerType int64
The reason an attempt was made: - Scheduled = 0 - Manual = 1
const ( MESSAGEATTEMPTTRIGGERTYPE_SCHEDULED MessageAttemptTriggerType = 0 MESSAGEATTEMPTTRIGGERTYPE_MANUAL MessageAttemptTriggerType = 1 )
func (*MessageAttemptTriggerType) UnmarshalJSON ¶
func (v *MessageAttemptTriggerType) UnmarshalJSON(src []byte) error
type MessageEndpointOut ¶
type MessageEndpointOut struct {
Channels []string `json:"channels,omitempty"` // List of message channels this endpoint listens to (omit for all).
CreatedAt time.Time `json:"createdAt"`
Description string `json:"description"` // An example endpoint name.
Disabled *bool `json:"disabled,omitempty"`
FilterTypes []string `json:"filterTypes,omitempty"`
Id string `json:"id"` // The Endpoint's ID.
NextAttempt *time.Time `json:"nextAttempt,omitempty"`
RateLimit *uint16 `json:"rateLimit,omitempty"`
Status MessageStatus `json:"status"`
Uid *string `json:"uid,omitempty"` // Optional unique identifier for the endpoint.
UpdatedAt time.Time `json:"updatedAt"`
Url string `json:"url"`
Version int32 `json:"version"`
}
type MessageIn ¶
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 by
EventId *string `json:"eventId,omitempty"` // Optional unique identifier for the message
EventType string `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 messages
TransformationsParams *map[string]any `json:"transformationsParams,omitempty"` // Extra parameters to pass to Transformations (for future use)
}
type MessageOut ¶
type MessageOut struct {
Channels []string `json:"channels,omitempty"` // List of free-form identifiers that endpoints can filter by
EventId *string `json:"eventId,omitempty"` // Optional unique identifier for the message
EventType string `json:"eventType"` // The event type's name
Id string `json:"id"` // The Message's ID.
Payload map[string]any `json:"payload"`
Tags []string `json:"tags,omitempty"`
Timestamp time.Time `json:"timestamp"`
}
type MessageStatus ¶
type MessageStatus int64
The sending status of the message: - Success = 0 - Pending = 1 - Fail = 2 - Sending = 3
const ( MESSAGESTATUS_SUCCESS MessageStatus = 0 MESSAGESTATUS_PENDING MessageStatus = 1 MESSAGESTATUS_FAIL MessageStatus = 2 MESSAGESTATUS_SENDING MessageStatus = 3 )
func (*MessageStatus) UnmarshalJSON ¶
func (v *MessageStatus) UnmarshalJSON(src []byte) error
type OperationalWebhookEndpointIn ¶
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.
Url string `json:"url"`
}
type OperationalWebhookEndpointOut ¶
type OperationalWebhookEndpointOut struct {
CreatedAt time.Time `json:"createdAt"`
Description string `json:"description"` // An example endpoint name.
Disabled *bool `json:"disabled,omitempty"`
FilterTypes []string `json:"filterTypes,omitempty"`
Id string `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.
UpdatedAt time.Time `json:"updatedAt"`
Url string `json:"url"`
}
type OperationalWebhookEndpointSecretIn ¶
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"`
}
type OperationalWebhookEndpointSecretOut ¶
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.
Key string `json:"key"`
}
type OperationalWebhookEndpointUpdate ¶
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.
Url string `json:"url"`
}
type Ordering ¶
type Ordering string
Defines the ordering in a listing of results.
func (*Ordering) UnmarshalJSON ¶
type PollingEndpointConsumerSeekIn ¶ added in v1.63.0
type PollingEndpointConsumerSeekOut ¶ added in v1.63.0
type PollingEndpointConsumerSeekOut struct {
Iterator string `json:"iterator"`
}
type PollingEndpointMessageOut ¶ added in v1.63.0
type PollingEndpointMessageOut struct {
Channels []string `json:"channels,omitempty"` // List of free-form identifiers that endpoints can filter by
EventId *string `json:"eventId,omitempty"` // Optional unique identifier for the message
EventType string `json:"eventType"` // The event type's name
Headers *map[string]string `json:"headers,omitempty"`
Id string `json:"id"` // The Message's ID.
Payload map[string]any `json:"payload"`
Tags []string `json:"tags,omitempty"`
Timestamp time.Time `json:"timestamp"`
}
The MessageOut equivalent of polling endpoint
type PollingEndpointOut ¶ added in v1.63.0
type PollingEndpointOut struct {
Data []PollingEndpointMessageOut `json:"data"`
Done bool `json:"done"`
Iterator string `json:"iterator"`
}
type RecoverOut ¶
type RecoverOut struct {
Id string `json:"id"` // The QueueBackgroundTask's ID.
Status BackgroundTaskStatus `json:"status"`
Task BackgroundTaskType `json:"task"`
}
type ReplayOut ¶
type ReplayOut struct {
Id string `json:"id"` // The QueueBackgroundTask's ID.
Status BackgroundTaskStatus `json:"status"`
Task BackgroundTaskType `json:"task"`
}
type RotateTokenOut ¶ added in v1.63.0
type RotateTokenOut struct {
IngestUrl string `json:"ingestUrl"`
}
type SegmentConfig ¶ added in v1.63.0
type SegmentConfig struct {
Secret *string `json:"secret,omitempty"`
}
type SegmentConfigOut ¶ added in v1.63.0
type SegmentConfigOut struct {
}
type ShopifyConfig ¶ added in v1.63.0
type ShopifyConfig struct {
Secret string `json:"secret"`
}
type ShopifyConfigOut ¶ added in v1.63.0
type ShopifyConfigOut struct {
}
type SlackConfig ¶ added in v1.63.0
type SlackConfig struct {
Secret string `json:"secret"`
}
type SlackConfigOut ¶ added in v1.63.0
type SlackConfigOut struct {
}
type StatusCodeClass ¶
type StatusCodeClass int64
The different classes of HTTP status codes: - CodeNone = 0 - Code1xx = 100 - Code2xx = 200 - Code3xx = 300 - Code4xx = 400 - Code5xx = 500
const ( STATUSCODECLASS_CODE_NONE StatusCodeClass = 0 STATUSCODECLASS_CODE1XX StatusCodeClass = 100 STATUSCODECLASS_CODE2XX StatusCodeClass = 200 STATUSCODECLASS_CODE3XX StatusCodeClass = 300 STATUSCODECLASS_CODE4XX StatusCodeClass = 400 STATUSCODECLASS_CODE5XX StatusCodeClass = 500 )
func (*StatusCodeClass) UnmarshalJSON ¶
func (v *StatusCodeClass) UnmarshalJSON(src []byte) error
type StripeConfig ¶ added in v1.63.0
type StripeConfig struct {
Secret string `json:"secret"`
}
type StripeConfigOut ¶ added in v1.63.0
type StripeConfigOut struct {
}
type SvixConfig ¶ added in v1.63.0
type SvixConfig struct {
Secret string `json:"secret"`
}
type SvixConfigOut ¶ added in v1.63.0
type SvixConfigOut struct {
}
type TemplateOut ¶
type TemplateOut struct {
CreatedAt time.Time `json:"createdAt"`
Description string `json:"description"`
FeatureFlag *string `json:"featureFlag,omitempty"`
FilterTypes []string `json:"filterTypes,omitempty"`
Id string `json:"id"` // The TransformationTemplate's ID.
Instructions string `json:"instructions"`
InstructionsLink *string `json:"instructionsLink,omitempty"`
Kind ConnectorKind `json:"kind"`
Logo string `json:"logo"`
Name string `json:"name"`
OrgId string `json:"orgId"` // The Organization's ID.
Transformation string `json:"transformation"`
UpdatedAt time.Time `json:"updatedAt"`
}
type TransformationTemplateKind ¶
type TransformationTemplateKind string
const ( TRANSFORMATIONTEMPLATEKIND_CUSTOM TransformationTemplateKind = "Custom" TRANSFORMATIONTEMPLATEKIND_CUSTOMER_IO TransformationTemplateKind = "CustomerIO" TRANSFORMATIONTEMPLATEKIND_DISCORD TransformationTemplateKind = "Discord" TRANSFORMATIONTEMPLATEKIND_HUBSPOT TransformationTemplateKind = "Hubspot" TRANSFORMATIONTEMPLATEKIND_INNGEST TransformationTemplateKind = "Inngest" TRANSFORMATIONTEMPLATEKIND_SALESFORCE TransformationTemplateKind = "Salesforce" TRANSFORMATIONTEMPLATEKIND_SEGMENT TransformationTemplateKind = "Segment" TRANSFORMATIONTEMPLATEKIND_SLACK TransformationTemplateKind = "Slack" TRANSFORMATIONTEMPLATEKIND_TEAMS TransformationTemplateKind = "Teams" TRANSFORMATIONTEMPLATEKIND_TRIGGER_DEV TransformationTemplateKind = "TriggerDev" TRANSFORMATIONTEMPLATEKIND_WINDMILL TransformationTemplateKind = "Windmill" TRANSFORMATIONTEMPLATEKIND_ZAPIER TransformationTemplateKind = "Zapier" )
func (*TransformationTemplateKind) UnmarshalJSON ¶
func (v *TransformationTemplateKind) UnmarshalJSON(src []byte) error
type ZoomConfig ¶ added in v1.63.0
type ZoomConfig struct {
Secret string `json:"secret"`
}
type ZoomConfigOut ¶ added in v1.63.0
type ZoomConfigOut struct {
}
Source Files
¶
- adobe_sign_config.go
- adobe_sign_config_out.go
- aggregate_event_types_out.go
- api_token_censored_out.go
- api_token_expire_in.go
- api_token_in.go
- api_token_out.go
- app_portal_access_in.go
- app_portal_access_out.go
- app_usage_stats_in.go
- app_usage_stats_out.go
- application_in.go
- application_out.go
- application_patch.go
- application_token_expire_in.go
- background_task_finished_event.go
- background_task_finished_event2.go
- background_task_out.go
- background_task_status.go
- background_task_type.go
- connector_in.go
- connector_kind.go
- connector_out.go
- cron_config.go
- dashboard_access_out.go
- docusign_config.go
- docusign_config_out.go
- empty_map.go
- endpoint_created_event.go
- endpoint_created_event_data.go
- endpoint_deleted_event.go
- endpoint_deleted_event_data.go
- endpoint_disabled_event.go
- endpoint_disabled_event_data.go
- endpoint_disabled_trigger.go
- endpoint_enabled_event.go
- endpoint_enabled_event_data.go
- endpoint_headers_in.go
- endpoint_headers_out.go
- endpoint_headers_patch_in.go
- endpoint_in.go
- endpoint_message_out.go
- endpoint_out.go
- endpoint_patch.go
- endpoint_secret_out.go
- endpoint_secret_rotate_in.go
- endpoint_stats.go
- endpoint_transformation_in.go
- endpoint_transformation_out.go
- endpoint_update.go
- endpoint_updated_event.go
- endpoint_updated_event_data.go
- environment_in.go
- environment_out.go
- event_example_in.go
- event_type_from_open_api.go
- event_type_import_open_api_in.go
- event_type_import_open_api_out.go
- event_type_import_open_api_out_data.go
- event_type_in.go
- event_type_out.go
- event_type_patch.go
- event_type_update.go
- expung_all_contents_out.go
- expunge_all_contents_out.go
- github_config.go
- github_config_out.go
- hubspot_config.go
- hubspot_config_out.go
- ingest_endpoint_headers_in.go
- ingest_endpoint_headers_out.go
- ingest_endpoint_in.go
- ingest_endpoint_out.go
- ingest_endpoint_secret_in.go
- ingest_endpoint_secret_out.go
- ingest_endpoint_update.go
- ingest_source_consumer_portal_access_in.go
- ingest_source_in.go
- ingest_source_out.go
- integration_in.go
- integration_key_out.go
- integration_out.go
- integration_update.go
- list_response_api_token_censored_out.go
- list_response_application_out.go
- list_response_background_task_out.go
- list_response_endpoint_message_out.go
- list_response_endpoint_out.go
- list_response_event_type_out.go
- list_response_ingest_endpoint_out.go
- list_response_ingest_source_out.go
- list_response_integration_out.go
- list_response_message_attempt_out.go
- list_response_message_endpoint_out.go
- list_response_message_out.go
- list_response_operational_webhook_endpoint_out.go
- message_attempt_exhausted_event.go
- message_attempt_exhausted_event_data.go
- message_attempt_failed_data.go
- message_attempt_failing_event.go
- message_attempt_failing_event_data.go
- message_attempt_out.go
- message_attempt_recovered_event.go
- message_attempt_recovered_event_data.go
- message_attempt_trigger_type.go
- message_endpoint_out.go
- message_in.go
- message_out.go
- message_status.go
- operational_webhook_endpoint_headers_in.go
- operational_webhook_endpoint_headers_out.go
- operational_webhook_endpoint_in.go
- operational_webhook_endpoint_out.go
- operational_webhook_endpoint_secret_in.go
- operational_webhook_endpoint_secret_out.go
- operational_webhook_endpoint_update.go
- ordering.go
- polling_endpoint_consumer_seek_in.go
- polling_endpoint_consumer_seek_out.go
- polling_endpoint_message_out.go
- polling_endpoint_out.go
- recover_in.go
- recover_out.go
- replay_in.go
- replay_out.go
- rotate_token_out.go
- segment_config.go
- segment_config_out.go
- shopify_config.go
- shopify_config_out.go
- slack_config.go
- slack_config_out.go
- status_code_class.go
- stripe_config.go
- stripe_config_out.go
- svix_config.go
- svix_config_out.go
- template_out.go
- transformation_template_kind.go
- zoom_config.go
- zoom_config_out.go