---
sidebar:
  hidden: true
title: roboto.domain.orgs.webhook_integration
---
## Module Contents

### BeginWebhookIntegrationRequest

```python
class roboto.domain.orgs.webhook_integration.BeginWebhookIntegrationRequest(
    /,
    **data: Any,
)
```

`from roboto.domain.orgs.webhook_integration import BeginWebhookIntegrationRequest`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/orgs/webhook_integration.py#L21-L25)

Bases: `pydantic.BaseModel`

**!!! abstract "Usage Documentation"**

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

A base class for creating Pydantic models.

**Parameters**

- **data** (`Any`)

**Attributes**

- **`BeginWebhookIntegrationRequest.__class_vars__`**: The names of the class variables defined on the model.
- **`BeginWebhookIntegrationRequest.__private_attributes__`**: Metadata about the private attributes of the model.
- **`BeginWebhookIntegrationRequest.__signature__`**: The synthesized \_\_init\_\_ [Signature][inspect.Signature] of the model.
- **`BeginWebhookIntegrationRequest.__pydantic_complete__`**: Whether model building is completed, or if there are still undefined fields.
- **`BeginWebhookIntegrationRequest.__pydantic_core_schema__`**: The core schema of the model.
- **`BeginWebhookIntegrationRequest.__pydantic_custom_init__`**: Whether the model has a custom \_\_init\_\_ function.
- **`BeginWebhookIntegrationRequest.__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__`**: 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__`**: Parent namespace of the model, used for automatic rebuilding of models.
- **`BeginWebhookIntegrationRequest.__pydantic_post_init__`**: The name of the post-init method for the model, if defined.
- **`BeginWebhookIntegrationRequest.__pydantic_root_model__`**: Whether the model is a [RootModel][pydantic.root_model.RootModel].
- **`BeginWebhookIntegrationRequest.__pydantic_serializer__`**: The pydantic-core SchemaSerializer used to dump instances of the model.
- **`BeginWebhookIntegrationRequest.__pydantic_validator__`**: The pydantic-core SchemaValidator used to validate instances of the model.
- **`BeginWebhookIntegrationRequest.__pydantic_fields__`**: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.
- **`BeginWebhookIntegrationRequest.__pydantic_computed_fields__`**: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.
- **`BeginWebhookIntegrationRequest.__pydantic_extra__`**: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.
- **`BeginWebhookIntegrationRequest.__pydantic_fields_set__`**: The names of fields explicitly set during instantiation.
- **`BeginWebhookIntegrationRequest.__pydantic_private__`**: Values of private attributes set on the model instance.
- **BeginWebhookIntegrationRequest.org_id** (`str`)
- **BeginWebhookIntegrationRequest.user_config** (`dict[str, Any] | None`) = `None`
- **BeginWebhookIntegrationRequest.webhook_events** (`list[str]`)
- **BeginWebhookIntegrationRequest.webhook_provider** (`WebhookProvider`)

### UpdateWebhookIntegrationAPIKeyRequest

```python
class roboto.domain.orgs.webhook_integration.UpdateWebhookIntegrationAPIKeyRequest(
    /,
    **data: Any,
)
```

`from roboto.domain.orgs.webhook_integration import UpdateWebhookIntegrationAPIKeyRequest`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/orgs/webhook_integration.py#L36-L41)

Bases: `pydantic.BaseModel`

**!!! abstract "Usage Documentation"**

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

A base class for creating Pydantic models.

**Parameters**

- **data** (`Any`)

**Attributes**

- **`UpdateWebhookIntegrationAPIKeyRequest.__class_vars__`**: The names of the class variables defined on the model.
- **`UpdateWebhookIntegrationAPIKeyRequest.__private_attributes__`**: Metadata about the private attributes of the model.
- **`UpdateWebhookIntegrationAPIKeyRequest.__signature__`**: The synthesized \_\_init\_\_ [Signature][inspect.Signature] of the model.
- **`UpdateWebhookIntegrationAPIKeyRequest.__pydantic_complete__`**: Whether model building is completed, or if there are still undefined fields.
- **`UpdateWebhookIntegrationAPIKeyRequest.__pydantic_core_schema__`**: The core schema of the model.
- **`UpdateWebhookIntegrationAPIKeyRequest.__pydantic_custom_init__`**: Whether the model has a custom \_\_init\_\_ function.
- **`UpdateWebhookIntegrationAPIKeyRequest.__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__`**: 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__`**: Parent namespace of the model, used for automatic rebuilding of models.
- **`UpdateWebhookIntegrationAPIKeyRequest.__pydantic_post_init__`**: The name of the post-init method for the model, if defined.
- **`UpdateWebhookIntegrationAPIKeyRequest.__pydantic_root_model__`**: Whether the model is a [RootModel][pydantic.root_model.RootModel].
- **`UpdateWebhookIntegrationAPIKeyRequest.__pydantic_serializer__`**: The pydantic-core SchemaSerializer used to dump instances of the model.
- **`UpdateWebhookIntegrationAPIKeyRequest.__pydantic_validator__`**: The pydantic-core SchemaValidator used to validate instances of the model.
- **`UpdateWebhookIntegrationAPIKeyRequest.__pydantic_fields__`**: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.
- **`UpdateWebhookIntegrationAPIKeyRequest.__pydantic_computed_fields__`**: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.
- **`UpdateWebhookIntegrationAPIKeyRequest.__pydantic_extra__`**: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.
- **`UpdateWebhookIntegrationAPIKeyRequest.__pydantic_fields_set__`**: The names of fields explicitly set during instantiation.
- **`UpdateWebhookIntegrationAPIKeyRequest.__pydantic_private__`**: Values of private attributes set on the model instance.
- **UpdateWebhookIntegrationAPIKeyRequest.webhook_provider_api_key** (`pydantic.SecretStr`)

#### UpdateWebhookIntegrationAPIKeyRequest.serialize_over_the_wire()

```python
def serialize_over_the_wire(value: pydantic.SecretStr) -> str
```

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/orgs/webhook_integration.py#L40-L41)

**Parameters**

- **value** (`pydantic.SecretStr`)

**Returns**

- `str`

### UpdateWebhookIntegrationSecretRequest

```python
class roboto.domain.orgs.webhook_integration.UpdateWebhookIntegrationSecretRequest(
    /,
    **data: Any,
)
```

`from roboto.domain.orgs.webhook_integration import UpdateWebhookIntegrationSecretRequest`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/orgs/webhook_integration.py#L28-L33)

Bases: `pydantic.BaseModel`

**!!! abstract "Usage Documentation"**

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

A base class for creating Pydantic models.

**Parameters**

- **data** (`Any`)

**Attributes**

- **`UpdateWebhookIntegrationSecretRequest.__class_vars__`**: The names of the class variables defined on the model.
- **`UpdateWebhookIntegrationSecretRequest.__private_attributes__`**: Metadata about the private attributes of the model.
- **`UpdateWebhookIntegrationSecretRequest.__signature__`**: The synthesized \_\_init\_\_ [Signature][inspect.Signature] of the model.
- **`UpdateWebhookIntegrationSecretRequest.__pydantic_complete__`**: Whether model building is completed, or if there are still undefined fields.
- **`UpdateWebhookIntegrationSecretRequest.__pydantic_core_schema__`**: The core schema of the model.
- **`UpdateWebhookIntegrationSecretRequest.__pydantic_custom_init__`**: Whether the model has a custom \_\_init\_\_ function.
- **`UpdateWebhookIntegrationSecretRequest.__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__`**: 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__`**: Parent namespace of the model, used for automatic rebuilding of models.
- **`UpdateWebhookIntegrationSecretRequest.__pydantic_post_init__`**: The name of the post-init method for the model, if defined.
- **`UpdateWebhookIntegrationSecretRequest.__pydantic_root_model__`**: Whether the model is a [RootModel][pydantic.root_model.RootModel].
- **`UpdateWebhookIntegrationSecretRequest.__pydantic_serializer__`**: The pydantic-core SchemaSerializer used to dump instances of the model.
- **`UpdateWebhookIntegrationSecretRequest.__pydantic_validator__`**: The pydantic-core SchemaValidator used to validate instances of the model.
- **`UpdateWebhookIntegrationSecretRequest.__pydantic_fields__`**: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.
- **`UpdateWebhookIntegrationSecretRequest.__pydantic_computed_fields__`**: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.
- **`UpdateWebhookIntegrationSecretRequest.__pydantic_extra__`**: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.
- **`UpdateWebhookIntegrationSecretRequest.__pydantic_fields_set__`**: The names of fields explicitly set during instantiation.
- **`UpdateWebhookIntegrationSecretRequest.__pydantic_private__`**: Values of private attributes set on the model instance.
- **UpdateWebhookIntegrationSecretRequest.webhook_secret** (`pydantic.SecretStr`)

#### UpdateWebhookIntegrationSecretRequest.serialize_over_the_wire()

```python
def serialize_over_the_wire(value: pydantic.SecretStr) -> str
```

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/orgs/webhook_integration.py#L32-L33)

**Parameters**

- **value** (`pydantic.SecretStr`)

**Returns**

- `str`

### WebhookIntegrationRecord

```python
class roboto.domain.orgs.webhook_integration.WebhookIntegrationRecord(/, **data: Any)
```

`from roboto.domain.orgs.webhook_integration import WebhookIntegrationRecord`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/orgs/webhook_integration.py#L44-L57)

Bases: `pydantic.BaseModel`

**!!! abstract "Usage Documentation"**

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

A base class for creating Pydantic models.

**Parameters**

- **data** (`Any`)

**Attributes**

- **`WebhookIntegrationRecord.__class_vars__`**: The names of the class variables defined on the model.
- **`WebhookIntegrationRecord.__private_attributes__`**: Metadata about the private attributes of the model.
- **`WebhookIntegrationRecord.__signature__`**: The synthesized \_\_init\_\_ [Signature][inspect.Signature] of the model.
- **`WebhookIntegrationRecord.__pydantic_complete__`**: Whether model building is completed, or if there are still undefined fields.
- **`WebhookIntegrationRecord.__pydantic_core_schema__`**: The core schema of the model.
- **`WebhookIntegrationRecord.__pydantic_custom_init__`**: Whether the model has a custom \_\_init\_\_ function.
- **`WebhookIntegrationRecord.__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__`**: 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__`**: Parent namespace of the model, used for automatic rebuilding of models.
- **`WebhookIntegrationRecord.__pydantic_post_init__`**: The name of the post-init method for the model, if defined.
- **`WebhookIntegrationRecord.__pydantic_root_model__`**: Whether the model is a [RootModel][pydantic.root_model.RootModel].
- **`WebhookIntegrationRecord.__pydantic_serializer__`**: The pydantic-core SchemaSerializer used to dump instances of the model.
- **`WebhookIntegrationRecord.__pydantic_validator__`**: The pydantic-core SchemaValidator used to validate instances of the model.
- **`WebhookIntegrationRecord.__pydantic_fields__`**: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.
- **`WebhookIntegrationRecord.__pydantic_computed_fields__`**: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.
- **`WebhookIntegrationRecord.__pydantic_extra__`**: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.
- **`WebhookIntegrationRecord.__pydantic_fields_set__`**: The names of fields explicitly set during instantiation.
- **`WebhookIntegrationRecord.__pydantic_private__`**: Values of private attributes set on the model instance.
- **WebhookIntegrationRecord.api_key_registered** (`bool`)
- **WebhookIntegrationRecord.created** (`datetime.datetime`)
- **WebhookIntegrationRecord.created_by** (`str`)
- **WebhookIntegrationRecord.modified** (`datetime.datetime`)
- **WebhookIntegrationRecord.modified_by** (`str`)
- **WebhookIntegrationRecord.org_id** (`str`)
- **WebhookIntegrationRecord.secret_registered** (`bool`)
- **WebhookIntegrationRecord.status** (`str`)
- **WebhookIntegrationRecord.user_config** (`dict[str, Any] | None`) = `None`
- **WebhookIntegrationRecord.webhook_endpoint_id** (`str`)
- **WebhookIntegrationRecord.webhook_endpoint_url** (`str`)
- **WebhookIntegrationRecord.webhook_events** (`list[str]`)
- **WebhookIntegrationRecord.webhook_provider** (`WebhookProvider`)

### WebhookIntegrationService

```python
class roboto.domain.orgs.webhook_integration.WebhookIntegrationService(
    roboto_client: Optional[roboto.RobotoClient] = None,
)
```

`from roboto.domain.orgs.webhook_integration import WebhookIntegrationService`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/orgs/webhook_integration.py#L60-L81)

**Parameters**

- **roboto_client** (`Optional[roboto.RobotoClient]`)

#### WebhookIntegrationService.begin_webhook_integration()

```python
def begin_webhook_integration(
    org_id: str,
    webhook_provider: WebhookProvider,
    webhook_events: list[str],
    user_config: dict[str, Any] | None = None,
) -> WebhookIntegrationRecord
```

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/orgs/webhook_integration.py#L66-L81)

**Parameters**

- **org_id** (`str`)
- **webhook_provider** (`WebhookProvider`)
- **webhook_events** (`list[str]`)
- **user_config** (`dict[str, Any] | None`)

**Returns**

- `WebhookIntegrationRecord`

### WebhookProvider

```python
class roboto.domain.orgs.webhook_integration.WebhookProvider
```

`from roboto.domain.orgs.webhook_integration import WebhookProvider`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/orgs/webhook_integration.py#L17-L18)

Bases: `roboto.compat.StrEnum`

Enum where members are also (and must be) strings

**Attributes**

- **WebhookProvider.Foxglove** = `'foxglove'`