func NewMessageInRaw(eventTypestring,payloadstring,contentType *string,) *models.MessageIn

func SetUserAgentSuffix(s *Svix, userAgentSuffixstring)error

type AdobeSignConfig =models.AdobeSignConfig

type AdobeSignConfigOut =models.AdobeSignConfigOut

type AggregateEventTypesOut =models.AggregateEventTypesOut

type ApiTokenCensoredOut =models.ApiTokenCensoredOut

type ApiTokenExpireIn =models.ApiTokenExpireIn

type ApiTokenIn =models.ApiTokenIn

type ApiTokenOut =models.ApiTokenOut

type AppPortalAccessIn =models.AppPortalAccessIn

type AppPortalAccessOut =models.AppPortalAccessOut

type AppUsageStatsIn =models.AppUsageStatsIn

type AppUsageStatsOut =models.AppUsageStatsOut

type Application struct {// contains filtered or unexported fields}

func (*Application)Create¶

func (application *Application) Create(ctxcontext.Context,applicationInmodels.ApplicationIn,o *ApplicationCreateOptions,) (*models.ApplicationOut,error)

Create a new application.

func (*Application)Delete¶

func (application *Application) Delete(ctxcontext.Context,appIdstring,)error

Delete an application.

func (*Application)Get¶

func (application *Application) Get(ctxcontext.Context,appIdstring,) (*models.ApplicationOut,error)

Get an application.

func (*Application)GetOrCreate¶added inv0.52.0

func (application *Application) GetOrCreate(ctxcontext.Context,applicationInmodels.ApplicationIn,o *ApplicationCreateOptions,) (*models.ApplicationOut,error)

Get or create a new application.

func (*Application)List¶

func (application *Application) List(ctxcontext.Context,o *ApplicationListOptions,) (*models.ListResponseApplicationOut,error)

List of all the organization's applications.

func (*Application)Patch¶added inv1.6.0

func (application *Application) Patch(ctxcontext.Context,appIdstring,applicationPatchmodels.ApplicationPatch,) (*models.ApplicationOut,error)

Partially update an application.

func (*Application)Update¶

func (application *Application) Update(ctxcontext.Context,appIdstring,applicationInmodels.ApplicationIn,) (*models.ApplicationOut,error)

Update an application.

type ApplicationCreateOptions struct {IdempotencyKey *string}

type ApplicationIn =models.ApplicationIn

type ApplicationListOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// The sorting order of the returned itemsOrder *models.Ordering}

type ApplicationOut =models.ApplicationOut

type ApplicationPatch =models.ApplicationPatch

type ApplicationTokenExpireIn =models.ApplicationTokenExpireIn

type Authentication struct {// contains filtered or unexported fields}

func (*Authentication)AppPortalAccess¶added inv0.75.0

func (authentication *Authentication) AppPortalAccess(ctxcontext.Context,appIdstring,appPortalAccessInmodels.AppPortalAccessIn,o *AuthenticationAppPortalAccessOptions,) (*models.AppPortalAccessOut,error)

Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.

func (*Authentication)ExpireAll¶added inv1.57.0

func (authentication *Authentication) ExpireAll(ctxcontext.Context,appIdstring,applicationTokenExpireInmodels.ApplicationTokenExpireIn,o *AuthenticationExpireAllOptions,)error

Expire all of the tokens associated with a specific application.

func (*Authentication)Logout¶

func (authentication *Authentication) Logout(ctxcontext.Context,o *AuthenticationLogoutOptions,)error

Logout an app token.

Trying to log out other tokens will fail.

type AuthenticationAppPortalAccessOptions struct {IdempotencyKey *string}

type AuthenticationDashboardAccessOptions struct {IdempotencyKey *string}

type AuthenticationExpireAllOptions struct {IdempotencyKey *string}

type AuthenticationLogoutOptions struct {IdempotencyKey *string}

type BackgroundTask struct {// contains filtered or unexported fields}

func (*BackgroundTask)Get¶added inv1.4.12

func (backgroundTask *BackgroundTask) Get(ctxcontext.Context,taskIdstring,) (*models.BackgroundTaskOut,error)

Get a background task by ID.

func (*BackgroundTask)List¶added inv1.4.12

func (backgroundTask *BackgroundTask) List(ctxcontext.Context,o *BackgroundTaskListOptions,) (*models.ListResponseBackgroundTaskOut,error)

List background tasks executed in the past 90 days.

type BackgroundTaskFinishedEvent =models.BackgroundTaskFinishedEvent

type BackgroundTaskFinishedEvent2 =models.BackgroundTaskFinishedEvent2

type BackgroundTaskListOptions struct {// Filter the response based on the status.Status *models.BackgroundTaskStatus// Filter the response based on the type.Task *models.BackgroundTaskType// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// The sorting order of the returned itemsOrder *models.Ordering}

type BackgroundTaskOut =models.BackgroundTaskOut

type BackgroundTaskStatus =models.BackgroundTaskStatus

type BackgroundTaskType =models.BackgroundTaskType

type ConnectorIn =models.ConnectorIn

type ConnectorKind =models.ConnectorKind

type ConnectorOut =models.ConnectorOut

type CronConfig =models.CronConfig

type DashboardAccessOut =models.DashboardAccessOut

type DocusignConfig =models.DocusignConfig

type DocusignConfigOut =models.DocusignConfigOut

type Endpoint struct {// contains filtered or unexported fields}

func (*Endpoint)Create¶

func (endpoint *Endpoint) Create(ctxcontext.Context,appIdstring,endpointInmodels.EndpointIn,o *EndpointCreateOptions,) (*models.EndpointOut,error)

Create a new endpoint for the application.

When `secret` is `null` the secret is automatically generated (recommended).

func (*Endpoint)Delete¶

func (endpoint *Endpoint) Delete(ctxcontext.Context,appIdstring,endpointIdstring,)error

Delete an endpoint.

func (*Endpoint)Get¶

func (endpoint *Endpoint) Get(ctxcontext.Context,appIdstring,endpointIdstring,) (*models.EndpointOut,error)

Get an endpoint.

func (*Endpoint)GetHeaders¶

func (endpoint *Endpoint) GetHeaders(ctxcontext.Context,appIdstring,endpointIdstring,) (*models.EndpointHeadersOut,error)

Get the additional headers to be sent with the webhook.

func (*Endpoint)GetSecret¶

func (endpoint *Endpoint) GetSecret(ctxcontext.Context,appIdstring,endpointIdstring,) (*models.EndpointSecretOut,error)

Get the endpoint's signing secret.

This is used to verify the authenticity of the webhook.For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/).

func (*Endpoint)GetStats¶added inv0.66.0

func (endpoint *Endpoint) GetStats(ctxcontext.Context,appIdstring,endpointIdstring,o *EndpointGetStatsOptions,) (*models.EndpointStats,error)

Get basic statistics for the endpoint.

func (*Endpoint)List¶

func (endpoint *Endpoint) List(ctxcontext.Context,appIdstring,o *EndpointListOptions,) (*models.ListResponseEndpointOut,error)

List the application's endpoints.

func (*Endpoint)Patch¶added inv1.6.0

func (endpoint *Endpoint) Patch(ctxcontext.Context,appIdstring,endpointIdstring,endpointPatchmodels.EndpointPatch,) (*models.EndpointOut,error)

Partially update an endpoint.

func (*Endpoint)PatchHeaders¶

func (endpoint *Endpoint) PatchHeaders(ctxcontext.Context,appIdstring,endpointIdstring,endpointHeadersPatchInmodels.EndpointHeadersPatchIn,)error

Partially set the additional headers to be sent with the webhook.

func (*Endpoint)Recover¶

func (endpoint *Endpoint) Recover(ctxcontext.Context,appIdstring,endpointIdstring,recoverInmodels.RecoverIn,o *EndpointRecoverOptions,) (*models.RecoverOut,error)

Resend all failed messages since a given time.

Messages that were sent successfully, even if failed initially, are not resent.

func (*Endpoint)ReplayMissing¶added inv0.76.1

func (endpoint *Endpoint) ReplayMissing(ctxcontext.Context,appIdstring,endpointIdstring,replayInmodels.ReplayIn,o *EndpointReplayMissingOptions,) (*models.ReplayOut,error)

Replays messages to the endpoint.

Only messages that were created after `since` will be sent.Messages that were previously sent to the endpoint are not resent.

func (*Endpoint)RotateSecret¶

func (endpoint *Endpoint) RotateSecret(ctxcontext.Context,appIdstring,endpointIdstring,endpointSecretRotateInmodels.EndpointSecretRotateIn,o *EndpointRotateSecretOptions,)error

Rotates the endpoint's signing secret.

The previous secret will remain valid for the next 24 hours.

func (*Endpoint)SendExample¶added inv0.83.0

func (endpoint *Endpoint) SendExample(ctxcontext.Context,appIdstring,endpointIdstring,eventExampleInmodels.EventExampleIn,o *EndpointSendExampleOptions,) (*models.MessageOut,error)

Send an example message for an event.

func (*Endpoint)TransformationGet¶added inv0.76.0

func (endpoint *Endpoint) TransformationGet(ctxcontext.Context,appIdstring,endpointIdstring,) (*models.EndpointTransformationOut,error)

Get the transformation code associated with this endpoint.

func (*Endpoint)TransformationPartialUpdate¶added inv1.14.0

func (endpoint *Endpoint) TransformationPartialUpdate(ctxcontext.Context,appIdstring,endpointIdstring,endpointTransformationInmodels.EndpointTransformationIn,)error

Set or unset the transformation code associated with this endpoint.

func (*Endpoint)Update¶

func (endpoint *Endpoint) Update(ctxcontext.Context,appIdstring,endpointIdstring,endpointUpdatemodels.EndpointUpdate,) (*models.EndpointOut,error)

Update an endpoint.

func (*Endpoint)UpdateHeaders¶

func (endpoint *Endpoint) UpdateHeaders(ctxcontext.Context,appIdstring,endpointIdstring,endpointHeadersInmodels.EndpointHeadersIn,)error

Set the additional headers to be sent with the webhook.

type EndpointCreateOptions struct {IdempotencyKey *string}

type EndpointCreatedEvent =models.EndpointCreatedEvent

type EndpointCreatedEventData =models.EndpointCreatedEventData

type EndpointDeletedEvent =models.EndpointDeletedEvent

type EndpointDeletedEventData =models.EndpointDeletedEventData

type EndpointDisabledEvent =models.EndpointDisabledEvent

type EndpointDisabledEventData =models.EndpointDisabledEventData

type EndpointDisabledTrigger =models.EndpointDisabledTrigger

type EndpointEnabledEvent =models.EndpointEnabledEvent

type EndpointEnabledEventData =models.EndpointEnabledEventData

type EndpointGetStatsOptions struct {// Filter the range to data starting from this date.Since *time.Time// Filter the range to data ending by this date.Until *time.Time}

type EndpointHeadersIn =models.EndpointHeadersIn

type EndpointHeadersOut =models.EndpointHeadersOut

type EndpointHeadersPatchIn =models.EndpointHeadersPatchIn

type EndpointIn =models.EndpointIn

type EndpointListOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// The sorting order of the returned itemsOrder *models.Ordering}

type EndpointMessageOut =models.EndpointMessageOut

type EndpointOut =models.EndpointOut

type EndpointPatch =models.EndpointPatch

type EndpointRecoverOptions struct {IdempotencyKey *string}

type EndpointReplayMissingOptions struct {IdempotencyKey *string}

type EndpointRotateSecretOptions struct {IdempotencyKey *string}

type EndpointSecretOut =models.EndpointSecretOut

type EndpointSecretRotateIn =models.EndpointSecretRotateIn

type EndpointSendExampleOptions struct {IdempotencyKey *string}

type EndpointStats =models.EndpointStats

type EndpointTransformationIn =models.EndpointTransformationIn

type EndpointTransformationOut =models.EndpointTransformationOut

type EndpointUpdate =models.EndpointUpdate

type EndpointUpdatedEvent =models.EndpointUpdatedEvent

type EndpointUpdatedEventData =models.EndpointUpdatedEventData

type Environment struct {// contains filtered or unexported fields}

func (*Environment)Export¶added inv1.63.0

func (environment *Environment) Export(ctxcontext.Context,o *EnvironmentExportOptions,) (*models.EnvironmentOut,error)

Download a JSON file containing all org-settings and event types.

func (*Environment)Import¶added inv1.63.0

func (environment *Environment) Import(ctxcontext.Context,environmentInmodels.EnvironmentIn,o *EnvironmentImportOptions,)error

Import a configuration into the active organization.

It doesn't delete anything, only adds / updates what was passed to it.

type EnvironmentExportOptions struct {IdempotencyKey *string}

type EnvironmentImportOptions struct {IdempotencyKey *string}

type EnvironmentIn =models.EnvironmentIn

type EnvironmentOut =models.EnvironmentOut

type Error =internal.Error

type EventExampleIn =models.EventExampleIn

type EventType struct {// contains filtered or unexported fields}

func (*EventType)Create¶

func (eventType *EventType) Create(ctxcontext.Context,eventTypeInmodels.EventTypeIn,o *EventTypeCreateOptions,) (*models.EventTypeOut,error)

Create new or unarchive existing event type.

Unarchiving an event type will allow endpoints to filter on it and messages to be sent with it.Endpoints filtering on the event type before archival will continue to filter on it.This operation does not preserve the description and schemas.

func (*EventType)Delete¶

func (eventType *EventType) Delete(ctxcontext.Context,eventTypeNamestring,o *EventTypeDeleteOptions,)error

Archive an event type.

Endpoints already configured to filter on an event type will continue to do so after archival.However, new messages can not be sent with it and endpoints can not filter on it.An event type can be unarchived with the[create operation](#operation/create_event_type_api_v1_event_type__post).

func (*EventType)Get¶

func (eventType *EventType) Get(ctxcontext.Context,eventTypeNamestring,) (*models.EventTypeOut,error)

Get an event type.

func (*EventType)ImportOpenapi¶added inv1.57.0

func (eventType *EventType) ImportOpenapi(ctxcontext.Context,eventTypeImportOpenApiInmodels.EventTypeImportOpenApiIn,o *EventTypeImportOpenapiOptions,) (*models.EventTypeImportOpenApiOut,error)

Given an OpenAPI spec, create new or update existing event types.If an existing `archived` event type is updated, it will be unarchived.

The importer will convert all webhooks found in the either the `webhooks` or `x-webhooks`top-level.

func (*EventType)List¶

func (eventType *EventType) List(ctxcontext.Context,o *EventTypeListOptions,) (*models.ListResponseEventTypeOut,error)

Return the list of event types.

func (*EventType)Patch¶added inv1.6.0

func (eventType *EventType) Patch(ctxcontext.Context,eventTypeNamestring,eventTypePatchmodels.EventTypePatch,) (*models.EventTypeOut,error)

Partially update an event type.

func (*EventType)Update¶

func (eventType *EventType) Update(ctxcontext.Context,eventTypeNamestring,eventTypeUpdatemodels.EventTypeUpdate,) (*models.EventTypeOut,error)

Update an event type.

type EventTypeCreateOptions struct {IdempotencyKey *string}

type EventTypeDeleteOptions struct {// By default event types are archived when "deleted". Passing this to `true` deletes them entirely.Expunge *bool}

type EventTypeFromOpenApi =models.EventTypeFromOpenApi

type EventTypeImportOpenApiIn =models.EventTypeImportOpenApiIn

type EventTypeImportOpenApiOut =models.EventTypeImportOpenApiOut

type EventTypeImportOpenApiOutData =models.EventTypeImportOpenApiOutData

type EventTypeImportOpenapiOptions struct {IdempotencyKey *string}

type EventTypeIn =models.EventTypeIn

type EventTypeListOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// The sorting order of the returned itemsOrder *models.Ordering// When `true` archived (deleted but not expunged) items are included in the response.IncludeArchived *bool// When `true` the full item (including the schema) is included in the response.WithContent *bool}

type EventTypeOut =models.EventTypeOut

type EventTypePatch =models.EventTypePatch

type EventTypeUpdate =models.EventTypeUpdate

type ExpungeAllContentsOut =models.ExpungeAllContentsOut

type GithubConfig =models.GithubConfig

type GithubConfigOut =models.GithubConfigOut

type HubspotConfig =models.HubspotConfig

type HubspotConfigOut =models.HubspotConfigOut

type Ingest struct {Endpoint *IngestEndpointSource   *IngestSource// contains filtered or unexported fields}

func (*Ingest)Dashboard¶added inv1.63.0

func (ingest *Ingest) Dashboard(ctxcontext.Context,sourceIdstring,ingestSourceConsumerPortalAccessInmodels.IngestSourceConsumerPortalAccessIn,o *IngestDashboardOptions,) (*models.DashboardAccessOut,error)

Get access to the Ingest Source Consumer Portal.

type IngestDashboardOptions struct {IdempotencyKey *string}

type IngestEndpoint struct {// contains filtered or unexported fields}

func (*IngestEndpoint)Create¶added inv1.63.0

func (ingestEndpoint *IngestEndpoint) Create(ctxcontext.Context,sourceIdstring,ingestEndpointInmodels.IngestEndpointIn,o *IngestEndpointCreateOptions,) (*models.IngestEndpointOut,error)

Create an ingest endpoint.

func (*IngestEndpoint)Delete¶added inv1.63.0

func (ingestEndpoint *IngestEndpoint) Delete(ctxcontext.Context,sourceIdstring,endpointIdstring,)error

Delete an ingest endpoint.

func (*IngestEndpoint)Get¶added inv1.63.0

func (ingestEndpoint *IngestEndpoint) Get(ctxcontext.Context,sourceIdstring,endpointIdstring,) (*models.IngestEndpointOut,error)

Get an ingest endpoint.

func (*IngestEndpoint)GetHeaders¶added inv1.63.0

func (ingestEndpoint *IngestEndpoint) GetHeaders(ctxcontext.Context,sourceIdstring,endpointIdstring,) (*models.IngestEndpointHeadersOut,error)

Get the additional headers to be sent with the ingest.

func (*IngestEndpoint)GetSecret¶added inv1.63.0

func (ingestEndpoint *IngestEndpoint) GetSecret(ctxcontext.Context,sourceIdstring,endpointIdstring,) (*models.IngestEndpointSecretOut,error)

Get an ingest endpoint's signing secret.

This is used to verify the authenticity of the webhook.For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/).

func (*IngestEndpoint)List¶added inv1.63.0

func (ingestEndpoint *IngestEndpoint) List(ctxcontext.Context,sourceIdstring,o *IngestEndpointListOptions,) (*models.ListResponseIngestEndpointOut,error)

List ingest endpoints.

func (*IngestEndpoint)RotateSecret¶added inv1.63.0

func (ingestEndpoint *IngestEndpoint) RotateSecret(ctxcontext.Context,sourceIdstring,endpointIdstring,ingestEndpointSecretInmodels.IngestEndpointSecretIn,o *IngestEndpointRotateSecretOptions,)error

Rotates an ingest endpoint's signing secret.

The previous secret will remain valid for the next 24 hours.

func (*IngestEndpoint)Update¶added inv1.63.0

func (ingestEndpoint *IngestEndpoint) Update(ctxcontext.Context,sourceIdstring,endpointIdstring,ingestEndpointUpdatemodels.IngestEndpointUpdate,) (*models.IngestEndpointOut,error)

Update an ingest endpoint.

func (*IngestEndpoint)UpdateHeaders¶added inv1.63.0

func (ingestEndpoint *IngestEndpoint) UpdateHeaders(ctxcontext.Context,sourceIdstring,endpointIdstring,ingestEndpointHeadersInmodels.IngestEndpointHeadersIn,)error

Set the additional headers to be sent to the endpoint.

type IngestEndpointCreateOptions struct {IdempotencyKey *string}

type IngestEndpointHeadersIn =models.IngestEndpointHeadersIn

type IngestEndpointHeadersOut =models.IngestEndpointHeadersOut

type IngestEndpointIn =models.IngestEndpointIn

type IngestEndpointListOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// The sorting order of the returned itemsOrder *models.Ordering}

type IngestEndpointOut =models.IngestEndpointOut

type IngestEndpointRotateSecretOptions struct {IdempotencyKey *string}

type IngestEndpointSecretIn =models.IngestEndpointSecretIn

type IngestEndpointSecretOut =models.IngestEndpointSecretOut

type IngestEndpointUpdate =models.IngestEndpointUpdate

type IngestSource struct {// contains filtered or unexported fields}

func (*IngestSource)Create¶added inv1.63.0

func (ingestSource *IngestSource) Create(ctxcontext.Context,ingestSourceInmodels.IngestSourceIn,o *IngestSourceCreateOptions,) (*models.IngestSourceOut,error)

Create Ingest Source.

func (*IngestSource)Delete¶added inv1.63.0

func (ingestSource *IngestSource) Delete(ctxcontext.Context,sourceIdstring,)error

Delete an Ingest Source.

func (*IngestSource)Get¶added inv1.63.0

func (ingestSource *IngestSource) Get(ctxcontext.Context,sourceIdstring,) (*models.IngestSourceOut,error)

Get an Ingest Source by id or uid.

func (*IngestSource)List¶added inv1.63.0

func (ingestSource *IngestSource) List(ctxcontext.Context,o *IngestSourceListOptions,) (*models.ListResponseIngestSourceOut,error)

List of all the organization's Ingest Sources.

func (*IngestSource)RotateToken¶added inv1.63.0

func (ingestSource *IngestSource) RotateToken(ctxcontext.Context,sourceIdstring,o *IngestSourceRotateTokenOptions,) (*models.RotateTokenOut,error)

Rotate the Ingest Source's Url Token.

This will rotate the ingest source's token, which is used toconstruct the unique `ingestUrl` for the source. Previous tokenswill remain valid for 48 hours after rotation. The token can berotated a maximum of three times within the 48-hour period.

func (*IngestSource)Update¶added inv1.63.0

func (ingestSource *IngestSource) Update(ctxcontext.Context,sourceIdstring,ingestSourceInmodels.IngestSourceIn,) (*models.IngestSourceOut,error)

Update an Ingest Source.

type IngestSourceConsumerPortalAccessIn =models.IngestSourceConsumerPortalAccessIn

type IngestSourceCreateOptions struct {IdempotencyKey *string}

type IngestSourceIn =models.IngestSourceIn

type IngestSourceListOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// The sorting order of the returned itemsOrder *models.Ordering}

type IngestSourceOut =models.IngestSourceOut

type IngestSourceRotateTokenOptions struct {IdempotencyKey *string}

type Integration struct {// contains filtered or unexported fields}

func (*Integration)Create¶

func (integration *Integration) Create(ctxcontext.Context,appIdstring,integrationInmodels.IntegrationIn,o *IntegrationCreateOptions,) (*models.IntegrationOut,error)

Create an integration.

func (*Integration)Delete¶

func (integration *Integration) Delete(ctxcontext.Context,appIdstring,integIdstring,)error

Delete an integration.

func (*Integration)Get¶

func (integration *Integration) Get(ctxcontext.Context,appIdstring,integIdstring,) (*models.IntegrationOut,error)

Get an integration.

func (*Integration)List¶

func (integration *Integration) List(ctxcontext.Context,appIdstring,o *IntegrationListOptions,) (*models.ListResponseIntegrationOut,error)

List the application's integrations.

func (*Integration)RotateKey¶

func (integration *Integration) RotateKey(ctxcontext.Context,appIdstring,integIdstring,o *IntegrationRotateKeyOptions,) (*models.IntegrationKeyOut,error)

Rotate the integration's key. The previous key will be immediately revoked.

func (*Integration)Update¶

func (integration *Integration) Update(ctxcontext.Context,appIdstring,integIdstring,integrationUpdatemodels.IntegrationUpdate,) (*models.IntegrationOut,error)

Update an integration.

type IntegrationCreateOptions struct {IdempotencyKey *string}

type IntegrationIn =models.IntegrationIn

type IntegrationKeyOut =models.IntegrationKeyOut

type IntegrationListOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// The sorting order of the returned itemsOrder *models.Ordering}

type IntegrationOut =models.IntegrationOut

type IntegrationRotateKeyOptions struct {IdempotencyKey *string}

type IntegrationUpdate =models.IntegrationUpdate

type ListResponseApiTokenCensoredOut =models.ListResponseApiTokenCensoredOut

type ListResponseApplicationOut =models.ListResponseApplicationOut

type ListResponseBackgroundTaskOut =models.ListResponseBackgroundTaskOut

type ListResponseEndpointMessageOut =models.ListResponseEndpointMessageOut

type ListResponseEndpointOut =models.ListResponseEndpointOut

type ListResponseEventTypeOut =models.ListResponseEventTypeOut

type ListResponseIngestEndpointOut =models.ListResponseIngestEndpointOut

type ListResponseIngestSourceOut =models.ListResponseIngestSourceOut

type ListResponseIntegrationOut =models.ListResponseIntegrationOut

type ListResponseMessageAttemptOut =models.ListResponseMessageAttemptOut

type ListResponseMessageEndpointOut =models.ListResponseMessageEndpointOut

type ListResponseMessageOut =models.ListResponseMessageOut

type ListResponseOperationalWebhookEndpointOut =models.ListResponseOperationalWebhookEndpointOut

type Management struct {Authentication *ManagementAuthentication}

type ManagementAuthentication struct {// contains filtered or unexported fields}

func (*ManagementAuthentication)CreateApiToken¶added inv1.63.1

func (managementAuthentication *ManagementAuthentication) CreateApiToken(ctxcontext.Context,apiTokenInmodels.ApiTokenIn,o *ManagementAuthenticationCreateApiTokenOptions,) (*models.ApiTokenOut,error)

Create a new API Token.

func (*ManagementAuthentication)ExpireApiToken¶added inv1.63.1

func (managementAuthentication *ManagementAuthentication) ExpireApiToken(ctxcontext.Context,keyIdstring,apiTokenExpireInmodels.ApiTokenExpireIn,o *ManagementAuthenticationExpireApiTokenOptions,)error

Expire the selected API Token.

func (*ManagementAuthentication)ListApiTokens¶added inv1.63.1

func (managementAuthentication *ManagementAuthentication) ListApiTokens(ctxcontext.Context,o *ManagementAuthenticationListApiTokensOptions,) (*models.ListResponseApiTokenCensoredOut,error)

List all API Tokens.

type ManagementAuthenticationCreateApiTokenOptions struct {IdempotencyKey *string}

type ManagementAuthenticationExpireApiTokenOptions struct {IdempotencyKey *string}

type ManagementAuthenticationListApiTokensOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// The sorting order of the returned itemsOrder *models.Ordering}

type Message struct {Poller *MessagePoller// contains filtered or unexported fields}

func (*Message)Create¶

func (message *Message) Create(ctxcontext.Context,appIdstring,messageInmodels.MessageIn,o *MessageCreateOptions,) (*models.MessageOut,error)

Creates a new message and dispatches it to all of the application's endpoints.

The `eventId` is an optional custom unique ID. It's verified to be unique only up to a day, after that no verification will be made.If a message with the same `eventId` already exists for the application, a 409 conflict error will be returned.

The `eventType` indicates the type and schema of the event. All messages of a certain `eventType` are expected to have the same schema. Endpoints can choose to only listen to specific event types.Messages can also have `channels`, which similar to event types let endpoints filter by them. Unlike event types, messages can have multiple channels, and channels don't imply a specific message content or schema.

The `payload` property is the webhook's body (the actual webhook message). Svix supports payload sizes of up to 1MiB, though it's generally a good idea to keep webhook payloads small, probably no larger than 40kb.

func (*Message)ExpungeAllContents¶added inv1.58.2

func (message *Message) ExpungeAllContents(ctxcontext.Context,appIdstring,o *MessageExpungeAllContentsOptions,) (*models.ExpungeAllContentsOut,error)

Delete all message payloads for the application.

This operation is only available in the <a href="https://svix.com/pricing" target="_blank">Enterprise</a> plan.

func (*Message)ExpungeContent¶added inv0.76.0

func (message *Message) ExpungeContent(ctxcontext.Context,appIdstring,msgIdstring,)error

Delete the given message's payload.

Useful in cases when a message was accidentally sent with sensitive content.The message can't be replayed or resent once its payload has been deleted or expired.

func (*Message)Get¶

func (message *Message) Get(ctxcontext.Context,appIdstring,msgIdstring,o *MessageGetOptions,) (*models.MessageOut,error)

Get a message by its ID or eventID.

func (*Message)List¶

func (message *Message) List(ctxcontext.Context,appIdstring,o *MessageListOptions,) (*models.ListResponseMessageOut,error)

List all of the application's messages.

The `before` and `after` parameters let you filter all items created before or after a certain date. These can be used alongside an iterator to paginate over resultswithin a certain window.

Note that by default this endpoint is limited to retrieving 90 days' worth of datarelative to now or, if an iterator is provided, 90 days before/after the time indicatedby the iterator ID. If you require data beyond those time ranges, you will need to explicitlyset the `before` or `after` parameter as appropriate.

type MessageAttempt struct {// contains filtered or unexported fields}

func (*MessageAttempt)ExpungeContent¶added inv0.76.0

func (messageAttempt *MessageAttempt) ExpungeContent(ctxcontext.Context,appIdstring,msgIdstring,attemptIdstring,)error

Deletes the given attempt's response body.

Useful when an endpoint accidentally returned sensitive content.The message can't be replayed or resent once its payload has been deleted or expired.

func (*MessageAttempt)Get¶

func (messageAttempt *MessageAttempt) Get(ctxcontext.Context,appIdstring,msgIdstring,attemptIdstring,) (*models.MessageAttemptOut,error)

`msg_id`: Use a message id or a message `eventId`

func (*MessageAttempt)ListAttemptedDestinations¶

func (messageAttempt *MessageAttempt) ListAttemptedDestinations(ctxcontext.Context,appIdstring,msgIdstring,o *MessageAttemptListAttemptedDestinationsOptions,) (*models.ListResponseMessageEndpointOut,error)

List endpoints attempted by a given message.

Additionally includes metadata about the latest message attempt.By default, endpoints are listed in ascending order by ID.

func (*MessageAttempt)ListAttemptedMessages¶

func (messageAttempt *MessageAttempt) ListAttemptedMessages(ctxcontext.Context,appIdstring,endpointIdstring,o *MessageAttemptListAttemptedMessagesOptions,) (*models.ListResponseEndpointMessageOut,error)

List messages for a particular endpoint. Additionally includes metadata about the latest message attempt.

The `before` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.

Note that by default this endpoint is limited to retrieving 90 days' worth of datarelative to now or, if an iterator is provided, 90 days before/after the time indicatedby the iterator ID. If you require data beyond those time ranges, you will need to explicitlyset the `before` or `after` parameter as appropriate.

func (*MessageAttempt)ListByEndpoint¶added inv0.48.0

func (messageAttempt *MessageAttempt) ListByEndpoint(ctxcontext.Context,appIdstring,endpointIdstring,o *MessageAttemptListByEndpointOptions,) (*models.ListResponseMessageAttemptOut,error)

List attempts by endpoint id

Note that by default this endpoint is limited to retrieving 90 days' worth of datarelative to now or, if an iterator is provided, 90 days before/after the time indicatedby the iterator ID. If you require data beyond those time ranges, you will need to explicitlyset the `before` or `after` parameter as appropriate.

func (*MessageAttempt)ListByMsg¶added inv0.48.0

func (messageAttempt *MessageAttempt) ListByMsg(ctxcontext.Context,appIdstring,msgIdstring,o *MessageAttemptListByMsgOptions,) (*models.ListResponseMessageAttemptOut,error)

List attempts by message ID.

Note that by default this endpoint is limited to retrieving 90 days' worth of datarelative to now or, if an iterator is provided, 90 days before/after the time indicatedby the iterator ID. If you require data beyond those time ranges, you will need to explicitlyset the `before` or `after` parameter as appropriate.

func (*MessageAttempt)Resend¶

func (messageAttempt *MessageAttempt) Resend(ctxcontext.Context,appIdstring,msgIdstring,endpointIdstring,o *MessageAttemptResendOptions,)error

Resend a message to the specified endpoint.

type MessageAttemptExhaustedEvent =models.MessageAttemptExhaustedEvent

type MessageAttemptExhaustedEventData =models.MessageAttemptExhaustedEventData

type MessageAttemptFailedData =models.MessageAttemptFailedData

type MessageAttemptFailingEvent =models.MessageAttemptFailingEvent

type MessageAttemptFailingEventData =models.MessageAttemptFailingEventData

type MessageAttemptListAttemptedDestinationsOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string}

type MessageAttemptListAttemptedMessagesOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// Filter response based on the channelChannel *string// Filter response based on the message tagsTag *string// Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), or Sending (3)Status *models.MessageStatus// Only include items created before a certain dateBefore *time.Time// Only include items created after a certain dateAfter *time.Time// When `true` message payloads are included in the responseWithContent *bool// Filter response based on the event typeEventTypes *[]string}

type MessageAttemptListByEndpointOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), or Sending (3)Status *models.MessageStatus// Filter response based on the HTTP status codeStatusCodeClass *models.StatusCodeClass// Filter response based on the channelChannel *string// Filter response based on the tagTag *string// Only include items created before a certain dateBefore *time.Time// Only include items created after a certain dateAfter *time.Time// When `true` attempt content is included in the responseWithContent *bool// When `true`, the message information is included in the responseWithMsg *bool// Filter response based on the event typeEventTypes *[]string}

type MessageAttemptListByMsgOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), or Sending (3)Status *models.MessageStatus// Filter response based on the HTTP status codeStatusCodeClass *models.StatusCodeClass// Filter response based on the channelChannel *string// Filter response based on the tagTag *string// Filter the attempts based on the attempted endpointEndpointId *string// Only include items created before a certain dateBefore *time.Time// Only include items created after a certain dateAfter *time.Time// When `true` attempt content is included in the responseWithContent *bool// Filter response based on the event typeEventTypes *[]string}

type MessageAttemptOut =models.MessageAttemptOut

type MessageAttemptRecoveredEvent =models.MessageAttemptRecoveredEvent

type MessageAttemptRecoveredEventData =models.MessageAttemptRecoveredEventData

type MessageAttemptResendOptions struct {IdempotencyKey *string}

type MessageAttemptTriggerType =models.MessageAttemptTriggerType

type MessageCreateOptions struct {// When `true`, message payloads are included in the response.WithContent    *boolIdempotencyKey *string}

type MessageEndpointOut =models.MessageEndpointOut

type MessageExpungeAllContentsOptions struct {IdempotencyKey *string}

type MessageGetOptions struct {// When `true` message payloads are included in the response.WithContent *bool}

type MessageIn =models.MessageIn

type MessageListOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// Filter response based on the channel.Channel *string// Only include items created before a certain date.Before *time.Time// Only include items created after a certain date.After *time.Time// When `true` message payloads are included in the response.WithContent *bool// Filter messages matching the provided tag.Tag *string// Filter response based on the event typeEventTypes *[]string}

type MessageOut =models.MessageOut

type MessagePoller struct {// contains filtered or unexported fields}

func (*MessagePoller)ConsumerPoll¶added inv1.64.1

func (messagePoller *MessagePoller) ConsumerPoll(ctxcontext.Context,appIdstring,sinkIdstring,consumerIdstring,o *MessagePollerConsumerPollOptions,) (*models.PollingEndpointOut,error)

Reads the stream of created messages for an application, filtered on the Sink's event types andChannels, using server-managed iterator tracking.

func (*MessagePoller)ConsumerSeek¶added inv1.64.1

func (messagePoller *MessagePoller) ConsumerSeek(ctxcontext.Context,appIdstring,sinkIdstring,consumerIdstring,pollingEndpointConsumerSeekInmodels.PollingEndpointConsumerSeekIn,o *MessagePollerConsumerSeekOptions,) (*models.PollingEndpointConsumerSeekOut,error)

Sets the starting offset for the consumer of a polling endpoint.

func (*MessagePoller)Poll¶added inv1.64.1

func (messagePoller *MessagePoller) Poll(ctxcontext.Context,appIdstring,sinkIdstring,o *MessagePollerPollOptions,) (*models.PollingEndpointOut,error)

Reads the stream of created messages for an application, filtered on the Sink's event types and Channels.

type MessagePollerConsumerPollOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string}

type MessagePollerConsumerSeekOptions struct {IdempotencyKey *string}

type MessagePollerPollOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// Filters messages sent with this event type (optional).EventType *string// Filters messages sent with this channel (optional).Channel *stringAfter   *time.Time}

type MessageStatus =models.MessageStatus

type OperationalWebhook struct {Endpoint *OperationalWebhookEndpoint}

type OperationalWebhookEndpoint struct {// contains filtered or unexported fields}

func (*OperationalWebhookEndpoint)Create¶added inv1.39.0

func (operationalWebhookEndpoint *OperationalWebhookEndpoint) Create(ctxcontext.Context,operationalWebhookEndpointInmodels.OperationalWebhookEndpointIn,o *OperationalWebhookEndpointCreateOptions,) (*models.OperationalWebhookEndpointOut,error)

Create an operational webhook endpoint.

func (*OperationalWebhookEndpoint)Delete¶added inv1.39.0

func (operationalWebhookEndpoint *OperationalWebhookEndpoint) Delete(ctxcontext.Context,endpointIdstring,)error

Delete an operational webhook endpoint.

func (*OperationalWebhookEndpoint)Get¶added inv1.39.0

func (operationalWebhookEndpoint *OperationalWebhookEndpoint) Get(ctxcontext.Context,endpointIdstring,) (*models.OperationalWebhookEndpointOut,error)

Get an operational webhook endpoint.

func (*OperationalWebhookEndpoint)GetHeaders¶added inv1.57.0

func (operationalWebhookEndpoint *OperationalWebhookEndpoint) GetHeaders(ctxcontext.Context,endpointIdstring,) (*models.OperationalWebhookEndpointHeadersOut,error)

Get the additional headers to be sent with the operational webhook.

func (*OperationalWebhookEndpoint)GetSecret¶added inv1.39.0

func (operationalWebhookEndpoint *OperationalWebhookEndpoint) GetSecret(ctxcontext.Context,endpointIdstring,) (*models.OperationalWebhookEndpointSecretOut,error)

Get an operational webhook endpoint's signing secret.

This is used to verify the authenticity of the webhook.For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/).

func (*OperationalWebhookEndpoint)List¶added inv1.39.0

func (operationalWebhookEndpoint *OperationalWebhookEndpoint) List(ctxcontext.Context,o *OperationalWebhookEndpointListOptions,) (*models.ListResponseOperationalWebhookEndpointOut,error)

List operational webhook endpoints.

func (*OperationalWebhookEndpoint)RotateSecret¶added inv1.39.0

func (operationalWebhookEndpoint *OperationalWebhookEndpoint) RotateSecret(ctxcontext.Context,endpointIdstring,operationalWebhookEndpointSecretInmodels.OperationalWebhookEndpointSecretIn,o *OperationalWebhookEndpointRotateSecretOptions,)error

Rotates an operational webhook endpoint's signing secret.

The previous secret will remain valid for the next 24 hours.

func (*OperationalWebhookEndpoint)Update¶added inv1.39.0

func (operationalWebhookEndpoint *OperationalWebhookEndpoint) Update(ctxcontext.Context,endpointIdstring,operationalWebhookEndpointUpdatemodels.OperationalWebhookEndpointUpdate,) (*models.OperationalWebhookEndpointOut,error)

Update an operational webhook endpoint.

func (*OperationalWebhookEndpoint)UpdateHeaders¶added inv1.57.0

func (operationalWebhookEndpoint *OperationalWebhookEndpoint) UpdateHeaders(ctxcontext.Context,endpointIdstring,operationalWebhookEndpointHeadersInmodels.OperationalWebhookEndpointHeadersIn,)error

Set the additional headers to be sent with the operational webhook.

type OperationalWebhookEndpointCreateOptions struct {IdempotencyKey *string}

type OperationalWebhookEndpointHeadersIn =models.OperationalWebhookEndpointHeadersIn

type OperationalWebhookEndpointHeadersOut =models.OperationalWebhookEndpointHeadersOut

type OperationalWebhookEndpointIn =models.OperationalWebhookEndpointIn

type OperationalWebhookEndpointListOptions struct {// Limit the number of returned itemsLimit *uint64// The iterator returned from a prior invocationIterator *string// The sorting order of the returned itemsOrder *models.Ordering}

type OperationalWebhookEndpointOut =models.OperationalWebhookEndpointOut

type OperationalWebhookEndpointRotateSecretOptions struct {IdempotencyKey *string}

type OperationalWebhookEndpointSecretIn =models.OperationalWebhookEndpointSecretIn

type OperationalWebhookEndpointSecretOut =models.OperationalWebhookEndpointSecretOut

type OperationalWebhookEndpointUpdate =models.OperationalWebhookEndpointUpdate

type Ordering =models.Ordering

type PandaDocConfig =models.PandaDocConfig

type PandaDocConfigOut =models.PandaDocConfigOut

type PollingEndpointConsumerSeekIn =models.PollingEndpointConsumerSeekIn

type PollingEndpointConsumerSeekOut =models.PollingEndpointConsumerSeekOut

type PollingEndpointMessageOut =models.PollingEndpointMessageOut

type PollingEndpointOut =models.PollingEndpointOut

type RecoverIn =models.RecoverIn

type RecoverOut =models.RecoverOut

type ReplayIn =models.ReplayIn

type ReplayOut =models.ReplayOut

type RotateTokenOut =models.RotateTokenOut

type SegmentConfig =models.SegmentConfig

type SegmentConfigOut =models.SegmentConfigOut

type ShopifyConfig =models.ShopifyConfig

type ShopifyConfigOut =models.ShopifyConfigOut

type SlackConfig =models.SlackConfig

type SlackConfigOut =models.SlackConfigOut

type Statistics struct {// contains filtered or unexported fields}

func (*Statistics)AggregateAppStats¶added inv1.14.0

func (statistics *Statistics) AggregateAppStats(ctxcontext.Context,appUsageStatsInmodels.AppUsageStatsIn,o *StatisticsAggregateAppStatsOptions,) (*models.AppUsageStatsOut,error)

Creates a background task to calculate the message destinations for all applications in the environment.

Note that this endpoint is asynchronous. You will need to poll the `Get Background Task` endpoint toretrieve the results of the operation.

func (*Statistics)AggregateEventTypes¶added inv1.14.0

func (statistics *Statistics) AggregateEventTypes(ctxcontext.Context,) (*models.AggregateEventTypesOut,error)

Creates a background task to calculate the listed event types for all apps in the organization.

Note that this endpoint is asynchronous. You will need to poll the `Get Background Task` endpoint toretrieve the results of the operation.

type StatisticsAggregateAppStatsOptions struct {IdempotencyKey *string}

type StatusCodeClass =models.StatusCodeClass

type StripeConfig =models.StripeConfig

type StripeConfigOut =models.StripeConfigOut

type Svix struct {Authentication             *AuthenticationApplication                *ApplicationEndpoint                   *EndpointEnvironment                *EnvironmentEventType                  *EventTypeIngest                     *IngestIntegration                *IntegrationManagement                 *ManagementMessage                    *MessageMessageAttempt             *MessageAttemptStatistics                 *StatisticsOperationalWebhook         *OperationalWebhookOperationalWebhookEndpoint *OperationalWebhookEndpoint// contains filtered or unexported fields}

funcNew¶

func New(tokenstring, options *SvixOptions) (*Svix,error)

type SvixConfig =models.SvixConfig

type SvixConfigOut =models.SvixConfigOut

type SvixOptions struct {ServerUrl     *url.URLHTTPClient    *http.ClientRetrySchedule *[]time.DurationDebugbool}

type Webhook struct {// contains filtered or unexported fields}

funcNewWebhook¶

func NewWebhook(secretstring) (*Webhook,error)

funcNewWebhookRaw¶added inv0.63.0

func NewWebhookRaw(secret []byte) (*Webhook,error)

func (*Webhook)Sign¶

func (wh *Webhook) Sign(msgIdstring, timestamptime.Time, payload []byte) (string,error)

func (*Webhook)Verify¶

func (wh *Webhook) Verify(payload []byte, headershttp.Header)error

Verify validates the payload against the svix signature headersusing the webhooks signing secret.

Returns an error if the body or headers are missing/unreadableor if the signature doesn't match.

func (*Webhook)VerifyIgnoringTimestamp¶

func (wh *Webhook) VerifyIgnoringTimestamp(payload []byte, headershttp.Header)error

VerifyIgnoringTimestamp validates the payload against the svix signature headersusing the webhooks signing secret.

Returns an error if the body or headers are missing/unreadableor if the signature doesn't match.

WARNING: This function does not check the signature's timestamp.We recommend using the `Verify` function instead.

type ZoomConfig =models.ZoomConfig

type ZoomConfigOut =models.ZoomConfigOut