Module api Copy item path Source aggregate_event_types_out app_portal_access_in app_portal_access_out app_usage_stats_in app_usage_stats_out application_in application_out application_patch application_stats application_token_expire_in attempt_statistics_data attempt_statistics_response auth_token_out azure_blob_storage_config background_task_out background_task_status background_task_type big_query_config border_radius_config border_radius_enum client_secret_jwt_params_in completion_choice completion_message count_out create_stream_in create_token_in custom_color_palette custom_strings_override custom_theme_override dashboard_access_out duration endpoint_created_event endpoint_created_event_data endpoint_deleted_event endpoint_deleted_event_data endpoint_disabled_event endpoint_disabled_event_data endpoint_headers_in endpoint_headers_out endpoint_headers_patch_in endpoint_in endpoint_message_out endpoint_mtls_config_in endpoint_oauth_config_in endpoint_out endpoint_patch endpoint_secret_out endpoint_secret_rotate_in endpoint_stats endpoint_transformation_in endpoint_transformation_out endpoint_transformation_simulate_in endpoint_transformation_simulate_out endpoint_update endpoint_updated_event endpoint_updated_event_data environment_in environment_out environment_settings_out event_example_in event_in event_out event_stream_out event_type_example_out event_type_from_open_api event_type_import_open_api_in event_type_import_open_api_out event_type_import_open_api_out_data event_type_in event_type_out event_type_patch event_type_schema_in event_type_update export_event_type_out font_size_config generate_in generate_out google_cloud_storage_config http_error_out http_validation_error hubspot_oauth_config_in inbound_path_params incoming_webhook_payload_out integration_in integration_key_out integration_out integration_update kafka_security_protocol_type list_response_application_out_ list_response_application_stats_ list_response_background_task_out_ list_response_endpoint_message_out_ list_response_endpoint_out_ list_response_event_type_out_ list_response_integration_out_ list_response_message_attempt_endpoint_out_ list_response_message_attempt_out_ list_response_message_endpoint_out_ list_response_message_out_ list_response_operational_webhook_endpoint_out_ list_response_sink_out_ list_response_stream_event_type_out_ list_response_stream_out_ list_response_stream_sink_out_ list_response_template_out_ message_attempt_endpoint_out message_attempt_exhausted_event message_attempt_exhausted_event_data message_attempt_failed_data message_attempt_failing_event message_attempt_failing_event_data message_attempt_headers_out message_attempt_out message_attempt_recovered_event message_attempt_recovered_event_data message_attempt_trigger_type message_broadcast_in message_broadcast_out message_endpoint_out message_events_out message_in message_out message_raw_payload_out message_status message_subscriber_auth_token_out o_auth_payload_in o_auth_payload_out oauth2_auth_method_in oauth2_grant_type_in oauth_jws_signing_algorithm one_time_token_in one_time_token_out operational_webhook_endpoint_in operational_webhook_endpoint_out operational_webhook_endpoint_secret_in operational_webhook_endpoint_secret_out operational_webhook_endpoint_update ordering recover_in recover_out redshift_config replay_in replay_out retry_schedule_in_out rotated_url_out s3_config sink_http_config sink_in sink_in_one_of sink_in_one_of_1 sink_in_one_of_2 sink_in_one_of_3 sink_in_one_of_4 sink_otel_v1_config sink_out sink_payload_format sink_status sink_status_in sink_transform_in sink_transformation_out snowflake_config statistics_period status_code_class stream_event_type_in stream_event_type_out stream_event_type_patch stream_in stream_out stream_patch stream_sink_in stream_sink_in_one_of stream_sink_in_one_of_1 stream_sink_in_one_of_2 stream_sink_in_one_of_3 stream_sink_in_one_of_4 stream_sink_in_one_of_5 stream_sink_in_one_of_6 stream_sink_in_one_of_7 stream_sink_out stream_sink_patch template_in template_out template_patch template_update transformation_http_method transformation_simulate_in transformation_simulate_out transformation_template_kind validation_error AggregateAppStatsOptions AggregateEventTypesOut AppPortalAccessIn AppPortalAccessOut AppUsageStatsIn AppUsageStatsOut Application ApplicationIn ApplicationListOptions ApplicationOut ApplicationPatch ApplicationStats ApplicationTokenExpireIn AttemptStatisticsData AttemptStatisticsResponse AuthTokenOut Authentication AzureBlobStorageConfig BackgroundTask BackgroundTaskListOptions BackgroundTaskOut BigQueryConfig BigQueryConfig : Configuration for a Google Cloud BigQuery sink. BorderRadiusConfig ClientSecretJwtParamsIn CompletionChoice CompletionMessage CountOut CreateStreamIn CreateTokenIn CustomColorPalette CustomStringsOverride CustomThemeOverride DashboardAccessOut Duration Endpoint EndpointCreatedEvent EndpointCreatedEvent : Sent when an endpoint is created. EndpointCreatedEventData EndpointCreatedEventData : Sent when an endpoint is created, updated, or deleted EndpointDeletedEvent EndpointDeletedEvent : Sent when an endpoint is deleted. EndpointDeletedEventData EndpointDeletedEventData : Sent when an endpoint is created, updated, or deleted EndpointDisabledEvent EndpointDisabledEvent : Sent when an endpoint has been automatically disabled after continuous failures. EndpointDisabledEventData EndpointDisabledEventData : Sent when an endpoint has been automatically disabled after continuous failures. EndpointHeadersIn EndpointHeadersOut EndpointHeadersOut : The value of the headers is returned in the headers
field. Sensitive headers that have been redacted are returned in the sensitive field. EndpointHeadersPatchIn EndpointIn EndpointListOptions EndpointMessageOut EndpointMessageOut : A model containing information on a given message plus additional fields on the last attempt for that message. EndpointMtlsConfigIn EndpointOauthConfigIn EndpointOut EndpointPatch EndpointSecretOut EndpointSecretRotateIn EndpointStats EndpointStatsOptions EndpointTransformationIn EndpointTransformationOut EndpointTransformationSimulateIn EndpointTransformationSimulateOut EndpointUpdate EndpointUpdatedEvent EndpointUpdatedEvent : Sent when an endpoint is updated. EndpointUpdatedEventData EndpointUpdatedEventData : Sent when an endpoint is created, updated, or deleted EnvironmentIn EnvironmentOut EnvironmentSettingsOut EventExampleIn EventIn EventOut EventStreamOut EventType EventTypeExampleOut EventTypeFromOpenApi EventTypeImportOpenApiIn EventTypeImportOpenApiIn : 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 . EventTypeImportOpenApiOut EventTypeImportOpenApiOutData EventTypeIn EventTypeListOptions EventTypeOut EventTypePatch EventTypeSchemaIn EventTypeUpdate ExportEventTypeOut FontSizeConfig GenerateIn GenerateOut GoogleCloudStorageConfig GoogleCloudStorageConfig : Configuration for a Google Cloud Storage sink. Write stream events into the named bucket using the supplied Google Cloud credentials. HttpErrorOut HttpValidationError HubspotOauthConfigIn InboundPathParams IncomingWebhookPayloadOut Integration IntegrationIn IntegrationKeyOut IntegrationListOptions IntegrationOut IntegrationUpdate ListOptions ListResponseApplicationOut ListResponseApplicationStats ListResponseBackgroundTaskOut ListResponseEndpointMessageOut ListResponseEndpointOut ListResponseEventTypeOut ListResponseIntegrationOut ListResponseMessageAttemptEndpointOut ListResponseMessageAttemptOut ListResponseMessageEndpointOut ListResponseMessageOut ListResponseOperationalWebhookEndpointOut ListResponseSinkOut ListResponseStreamEventTypeOut ListResponseStreamOut ListResponseStreamSinkOut ListResponseTemplateOut Message MessageAttempt MessageAttemptEndpointOut MessageAttemptExhaustedEvent MessageAttemptExhaustedEvent : Sent when a message delivery has failed (all of the retry attempts have been exhausted). MessageAttemptExhaustedEventData MessageAttemptExhaustedEventData : 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. MessageAttemptFailedData MessageAttemptFailingEvent MessageAttemptFailingEvent : 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. MessageAttemptFailingEventData MessageAttemptFailingEventData : 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. MessageAttemptHeadersOut MessageAttemptListByEndpointOptions MessageAttemptListOptions MessageAttemptOut MessageAttemptRecoveredEvent MessageAttemptRecoveredEvent : Sent on a successful dispatch after an earlier failure op webhook has already been sent. MessageAttemptRecoveredEventData MessageAttemptRecoveredEventData : 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. MessageBroadcastIn MessageBroadcastOut MessageEndpointOut MessageEventsOut MessageIn MessageListOptions MessageOut MessageRawPayloadOut MessageSubscriberAuthTokenOut OAuthPayloadIn OAuthPayloadOut OneTimeTokenIn OneTimeTokenOut OperationalWebhookEndpoint OperationalWebhookEndpointIn OperationalWebhookEndpointListOptions OperationalWebhookEndpointOut OperationalWebhookEndpointSecretIn OperationalWebhookEndpointSecretOut OperationalWebhookEndpointUpdate PostOptions RecoverIn RecoverOut RedshiftConfig RedshiftConfig : Configuration parameters for defining a Redshift sink. ReplayIn ReplayOut RetryScheduleInOut RotatedUrlOut S3Config SinkHttpConfig SinkInOneOf SinkInOneOf1 SinkInOneOf2 SinkInOneOf3 SinkInOneOf4 SinkOtelV1Config SinkTransformIn SinkTransformationOut SnowflakeConfig SnowflakeConfig : Configuration parameters for defining a Snowflake sink. Statistics StreamEventTypeIn StreamEventTypeOut StreamEventTypePatch StreamIn StreamOut StreamPatch StreamSinkInOneOf StreamSinkInOneOf1 StreamSinkInOneOf2 StreamSinkInOneOf3 StreamSinkInOneOf4 StreamSinkInOneOf5 StreamSinkInOneOf6 StreamSinkInOneOf7 Svix Svix API client. SvixOptions TemplateIn TemplateOut TemplatePatch TemplateUpdate TransformationSimulateIn TransformationSimulateOut ValidationError ValidationError : Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these per 422 UNPROCESSABLE ENTITY error. BackgroundTaskStatus BackgroundTaskType BorderRadiusEnum KafkaSecurityProtocolType MessageAttemptTriggerType MessageAttemptTriggerType : The reason an attempt was made: - Scheduled = 0 - Manual = 1
The reason an attempt was made: - Scheduled = 0 - Manual = 1 MessageStatus MessageStatus : The sending status of the message: - Success = 0 - Pending = 1 - Fail = 2 - Sending = 3
The sending status of the message: - Success = 0 - Pending = 1 - Fail = 2 - Sending = 3 Oauth2AuthMethodIn Oauth2AuthMethodIn : The method used for authenticating to the OAuth authorization server. clientSecretJwt
will construct a JWT used for authentication with the oauth authorization server. This method is less commonly used and may not be supported by all oauth providers. clientSecretBasic
will authenticate to the oauth authorization server using an Authorization
header with the client secret as the value. This is the most common means of authentication. clientSecretPost
will authenticate to the oauth authorization server by passing the client secret in a client_secret
field in the request body. This method may not be supported by all oauth providers, and in general clientSecretBasic
should be preferred.
The method used for authenticating to the OAuth authorization server. clientSecretJwt
will construct a JWT used for authentication with the oauth authorization server. This method is less commonly used and may not be supported by all oauth providers. clientSecretBasic
will authenticate to the oauth authorization server using an Authorization
header with the client secret as the value. This is the most common means of authentication. clientSecretPost
will authenticate to the oauth authorization server by passing the client secret in a client_secret
field in the request body. This method may not be supported by all oauth providers, and in general clientSecretBasic
should be preferred. Oauth2GrantTypeIn OauthJwsSigningAlgorithm Ordering Ordering : Defines the ordering in a listing of results.
Defines the ordering in a listing of results. SinkIn SinkOut SinkPayloadFormat SinkStatus SinkStatusIn StatisticsPeriod StatisticsPeriod : Period length for a statistics data point
Period length for a statistics data point StatusCodeClass StatusCodeClass : The different classes of HTTP status codes: - CodeNone = 0 - Code1xx = 100 - Code2xx = 200 - Code3xx = 300 - Code4xx = 400 - Code5xx = 500
The different classes of HTTP status codes: - CodeNone = 0 - Code1xx = 100 - Code2xx = 200 - Code3xx = 300 - Code4xx = 400 - Code5xx = 500 StreamSinkIn StreamSinkOut StreamSinkPatch TransformationHttpMethod TransformationTemplateKind