Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview
On this page

roboto.domain.orgs.webhook_integration

Module Contents

BeginWebhookIntegrationRequest

class roboto.domain.orgs.webhook_integration.BeginWebhookIntegrationRequest(/, **data)#View Source

Bases: pydantic.BaseModel

!!! abstract “Usage Documentation”

[Models](../concepts/models.md)

A base class for creating Pydantic models.

Attributes

BeginWebhookIntegrationRequest.__class_vars__

__class_vars__ #

The names of the class variables defined on the model.

BeginWebhookIntegrationRequest.__private_attributes__

__private_attributes__ #

Metadata about the private attributes of the model.

BeginWebhookIntegrationRequest.__signature__

__signature__ #

The synthesized __init__ [Signature][inspect.Signature] of the model.

BeginWebhookIntegrationRequest.__pydantic_complete__

__pydantic_complete__ #

Whether model building is completed, or if there are still undefined fields.

BeginWebhookIntegrationRequest.__pydantic_core_schema__

__pydantic_core_schema__ #

The core schema of the model.

BeginWebhookIntegrationRequest.__pydantic_custom_init__

__pydantic_custom_init__ #

Whether the model has a custom __init__ function.

BeginWebhookIntegrationRequest.__pydantic_decorators__

__pydantic_decorators__ #

Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

BeginWebhookIntegrationRequest.__pydantic_generic_metadata__

__pydantic_generic_metadata__ #

A dictionary containing metadata about generic Pydantic models. The origin and args items map to the [__origin__][genericalias.__origin__] and [__args__][genericalias.__args__] attributes of [generic aliases][types-genericalias], and the parameter item maps to the __parameter__ attribute of generic classes.

BeginWebhookIntegrationRequest.__pydantic_parent_namespace__

__pydantic_parent_namespace__ #

Parent namespace of the model, used for automatic rebuilding of models.

BeginWebhookIntegrationRequest.__pydantic_post_init__

__pydantic_post_init__ #

The name of the post-init method for the model, if defined.

BeginWebhookIntegrationRequest.__pydantic_root_model__

__pydantic_root_model__ #

Whether the model is a [RootModel][pydantic.root_model.RootModel].

BeginWebhookIntegrationRequest.__pydantic_serializer__

__pydantic_serializer__ #

The pydantic-core SchemaSerializer used to dump instances of the model.

BeginWebhookIntegrationRequest.__pydantic_validator__

__pydantic_validator__ #

The pydantic-core SchemaValidator used to validate instances of the model.

BeginWebhookIntegrationRequest.__pydantic_fields__

__pydantic_fields__ #

A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

BeginWebhookIntegrationRequest.__pydantic_computed_fields__

__pydantic_computed_fields__ #

A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

BeginWebhookIntegrationRequest.__pydantic_extra__

__pydantic_extra__ #

A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

BeginWebhookIntegrationRequest.__pydantic_fields_set__

__pydantic_fields_set__ #

The names of fields explicitly set during instantiation.

BeginWebhookIntegrationRequest.__pydantic_private__

__pydantic_private__ #

Values of private attributes set on the model instance.

Parameters

data Any

Attributes

BeginWebhookIntegrationRequest.org_id

org_id str #

BeginWebhookIntegrationRequest.user_config

user_config dict[str, Any] | None = None #

BeginWebhookIntegrationRequest.webhook_events

webhook_events list[str] #

BeginWebhookIntegrationRequest.webhook_provider

webhook_provider WebhookProvider #

UpdateWebhookIntegrationAPIKeyRequest

class roboto.domain.orgs.webhook_integration.UpdateWebhookIntegrationAPIKeyRequest(/, **data)#View Source

Bases: pydantic.BaseModel

!!! abstract “Usage Documentation”

[Models](../concepts/models.md)

A base class for creating Pydantic models.

Attributes

UpdateWebhookIntegrationAPIKeyRequest.__class_vars__

__class_vars__ #

The names of the class variables defined on the model.

UpdateWebhookIntegrationAPIKeyRequest.__private_attributes__

__private_attributes__ #

Metadata about the private attributes of the model.

UpdateWebhookIntegrationAPIKeyRequest.__signature__

__signature__ #

The synthesized __init__ [Signature][inspect.Signature] of the model.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_complete__

__pydantic_complete__ #

Whether model building is completed, or if there are still undefined fields.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_core_schema__

__pydantic_core_schema__ #

The core schema of the model.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_custom_init__

__pydantic_custom_init__ #

Whether the model has a custom __init__ function.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_decorators__

__pydantic_decorators__ #

Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_generic_metadata__

__pydantic_generic_metadata__ #

A dictionary containing metadata about generic Pydantic models. The origin and args items map to the [__origin__][genericalias.__origin__] and [__args__][genericalias.__args__] attributes of [generic aliases][types-genericalias], and the parameter item maps to the __parameter__ attribute of generic classes.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_parent_namespace__

__pydantic_parent_namespace__ #

Parent namespace of the model, used for automatic rebuilding of models.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_post_init__

__pydantic_post_init__ #

The name of the post-init method for the model, if defined.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_root_model__

__pydantic_root_model__ #

Whether the model is a [RootModel][pydantic.root_model.RootModel].

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_serializer__

__pydantic_serializer__ #

The pydantic-core SchemaSerializer used to dump instances of the model.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_validator__

__pydantic_validator__ #

The pydantic-core SchemaValidator used to validate instances of the model.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_fields__

__pydantic_fields__ #

A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_computed_fields__

__pydantic_computed_fields__ #

A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_extra__

__pydantic_extra__ #

A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_fields_set__

__pydantic_fields_set__ #

The names of fields explicitly set during instantiation.

UpdateWebhookIntegrationAPIKeyRequest.__pydantic_private__

__pydantic_private__ #

Values of private attributes set on the model instance.

Parameters

data Any

UpdateWebhookIntegrationAPIKeyRequest.serialize_over_the_wire()

serialize_over_the_wire(value)#View Source

Parameters

value pydantic.SecretStr

Return type

str

Attributes

UpdateWebhookIntegrationAPIKeyRequest.webhook_provider_api_key

webhook_provider_api_key pydantic.SecretStr #

UpdateWebhookIntegrationSecretRequest

class roboto.domain.orgs.webhook_integration.UpdateWebhookIntegrationSecretRequest(/, **data)#View Source

Bases: pydantic.BaseModel

!!! abstract “Usage Documentation”

[Models](../concepts/models.md)

A base class for creating Pydantic models.

Attributes

UpdateWebhookIntegrationSecretRequest.__class_vars__

__class_vars__ #

The names of the class variables defined on the model.

UpdateWebhookIntegrationSecretRequest.__private_attributes__

__private_attributes__ #

Metadata about the private attributes of the model.

UpdateWebhookIntegrationSecretRequest.__signature__

__signature__ #

The synthesized __init__ [Signature][inspect.Signature] of the model.

UpdateWebhookIntegrationSecretRequest.__pydantic_complete__

__pydantic_complete__ #

Whether model building is completed, or if there are still undefined fields.

UpdateWebhookIntegrationSecretRequest.__pydantic_core_schema__

__pydantic_core_schema__ #

The core schema of the model.

UpdateWebhookIntegrationSecretRequest.__pydantic_custom_init__

__pydantic_custom_init__ #

Whether the model has a custom __init__ function.

UpdateWebhookIntegrationSecretRequest.__pydantic_decorators__

__pydantic_decorators__ #

Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

UpdateWebhookIntegrationSecretRequest.__pydantic_generic_metadata__

__pydantic_generic_metadata__ #

A dictionary containing metadata about generic Pydantic models. The origin and args items map to the [__origin__][genericalias.__origin__] and [__args__][genericalias.__args__] attributes of [generic aliases][types-genericalias], and the parameter item maps to the __parameter__ attribute of generic classes.

UpdateWebhookIntegrationSecretRequest.__pydantic_parent_namespace__

__pydantic_parent_namespace__ #

Parent namespace of the model, used for automatic rebuilding of models.

UpdateWebhookIntegrationSecretRequest.__pydantic_post_init__

__pydantic_post_init__ #

The name of the post-init method for the model, if defined.

UpdateWebhookIntegrationSecretRequest.__pydantic_root_model__

__pydantic_root_model__ #

Whether the model is a [RootModel][pydantic.root_model.RootModel].

UpdateWebhookIntegrationSecretRequest.__pydantic_serializer__

__pydantic_serializer__ #

The pydantic-core SchemaSerializer used to dump instances of the model.

UpdateWebhookIntegrationSecretRequest.__pydantic_validator__

__pydantic_validator__ #

The pydantic-core SchemaValidator used to validate instances of the model.

UpdateWebhookIntegrationSecretRequest.__pydantic_fields__

__pydantic_fields__ #

A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

UpdateWebhookIntegrationSecretRequest.__pydantic_computed_fields__

__pydantic_computed_fields__ #

A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

UpdateWebhookIntegrationSecretRequest.__pydantic_extra__

__pydantic_extra__ #

A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

UpdateWebhookIntegrationSecretRequest.__pydantic_fields_set__

__pydantic_fields_set__ #

The names of fields explicitly set during instantiation.

UpdateWebhookIntegrationSecretRequest.__pydantic_private__

__pydantic_private__ #

Values of private attributes set on the model instance.

Parameters

data Any

UpdateWebhookIntegrationSecretRequest.serialize_over_the_wire()

serialize_over_the_wire(value)#View Source

Parameters

value pydantic.SecretStr

Return type

str

Attributes

UpdateWebhookIntegrationSecretRequest.webhook_secret

webhook_secret pydantic.SecretStr #

WebhookIntegrationRecord

class roboto.domain.orgs.webhook_integration.WebhookIntegrationRecord(/, **data)#View Source

Bases: pydantic.BaseModel

!!! abstract “Usage Documentation”

[Models](../concepts/models.md)

A base class for creating Pydantic models.

Attributes

WebhookIntegrationRecord.__class_vars__

__class_vars__ #

The names of the class variables defined on the model.

WebhookIntegrationRecord.__private_attributes__

__private_attributes__ #

Metadata about the private attributes of the model.

WebhookIntegrationRecord.__signature__

__signature__ #

The synthesized __init__ [Signature][inspect.Signature] of the model.

WebhookIntegrationRecord.__pydantic_complete__

__pydantic_complete__ #

Whether model building is completed, or if there are still undefined fields.

WebhookIntegrationRecord.__pydantic_core_schema__

__pydantic_core_schema__ #

The core schema of the model.

WebhookIntegrationRecord.__pydantic_custom_init__

__pydantic_custom_init__ #

Whether the model has a custom __init__ function.

WebhookIntegrationRecord.__pydantic_decorators__

__pydantic_decorators__ #

Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

WebhookIntegrationRecord.__pydantic_generic_metadata__

__pydantic_generic_metadata__ #

A dictionary containing metadata about generic Pydantic models. The origin and args items map to the [__origin__][genericalias.__origin__] and [__args__][genericalias.__args__] attributes of [generic aliases][types-genericalias], and the parameter item maps to the __parameter__ attribute of generic classes.

WebhookIntegrationRecord.__pydantic_parent_namespace__

__pydantic_parent_namespace__ #

Parent namespace of the model, used for automatic rebuilding of models.

WebhookIntegrationRecord.__pydantic_post_init__

__pydantic_post_init__ #

The name of the post-init method for the model, if defined.

WebhookIntegrationRecord.__pydantic_root_model__

__pydantic_root_model__ #

Whether the model is a [RootModel][pydantic.root_model.RootModel].

WebhookIntegrationRecord.__pydantic_serializer__

__pydantic_serializer__ #

The pydantic-core SchemaSerializer used to dump instances of the model.

WebhookIntegrationRecord.__pydantic_validator__

__pydantic_validator__ #

The pydantic-core SchemaValidator used to validate instances of the model.

WebhookIntegrationRecord.__pydantic_fields__

__pydantic_fields__ #

A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

WebhookIntegrationRecord.__pydantic_computed_fields__

__pydantic_computed_fields__ #

A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

WebhookIntegrationRecord.__pydantic_extra__

__pydantic_extra__ #

A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

WebhookIntegrationRecord.__pydantic_fields_set__

__pydantic_fields_set__ #

The names of fields explicitly set during instantiation.

WebhookIntegrationRecord.__pydantic_private__

__pydantic_private__ #

Values of private attributes set on the model instance.

Parameters

data Any

Attributes

WebhookIntegrationRecord.api_key_registered

api_key_registered bool #

WebhookIntegrationRecord.created

created datetime.datetime #

WebhookIntegrationRecord.created_by

created_by str #

WebhookIntegrationRecord.modified

modified datetime.datetime #

WebhookIntegrationRecord.modified_by

modified_by str #

WebhookIntegrationRecord.org_id

org_id str #

WebhookIntegrationRecord.secret_registered

secret_registered bool #

WebhookIntegrationRecord.status

status str #

WebhookIntegrationRecord.user_config

user_config dict[str, Any] | None = None #

WebhookIntegrationRecord.webhook_endpoint_id

webhook_endpoint_id str #

WebhookIntegrationRecord.webhook_endpoint_url

webhook_endpoint_url str #

WebhookIntegrationRecord.webhook_events

webhook_events list[str] #

WebhookIntegrationRecord.webhook_provider

webhook_provider WebhookProvider #

WebhookIntegrationService

class roboto.domain.orgs.webhook_integration.WebhookIntegrationService(roboto_client=None)#View Source

Parameters

roboto_client Optional[roboto.RobotoClient]

WebhookIntegrationService.begin_webhook_integration()

begin_webhook_integration(org_id, webhook_provider, webhook_events, user_config=None)#View Source

Parameters

org_id str
webhook_provider WebhookProvider
webhook_events list[str]
user_config dict[str, Any] | None

WebhookProvider

class roboto.domain.orgs.webhook_integration.WebhookProvider#View Source

Bases: roboto.compat.StrEnum

Enum where members are also (and must be) strings

Attributes

WebhookProvider.Foxglove

Foxglove = 'foxglove' #

Was this page helpful?