Source: factory.core/extend.edit/ObjHookEdit.py
Extends ObjHook to provide load and save functionality for webhooks.
Simplified interface that handles complete webhook configurations
including all related parameters and validations.
| Method | Signature | Description |
|---|---|---|
| load | load(webhook_code: str, package: Optional[str] = None) -> JsonDict |
Load complete webhook configuration from database. |
| save | save(webhook_config: JsonDict) -> bool |
Save complete webhook configuration to database. |
| delete_webhook | delete_webhook(webhook_code: str) -> bool |
Delete webhook and all related data (cascade delete). |
| export_to_file | export_to_file(webhook_code: str, filename: Optional[str] = None, package: Optional[str] = None) -> bool |
Export webhook configuration to YAML file. |
| export_all_formats | export_all_formats(webhook_code: str, package: Optional[str] = None) -> bool |
Export webhook in all formats (YAML, Postman, Markdown). |
| import_from_file | import_from_file(filename: str, webhook_code: Optional[str] = None) -> bool |
Import webhook configuration from YAML file and save to database. |
| list_files | list_files() -> list[str] |
List all webhook YAML files in the webhooks folder. |
| export_to_postman | export_to_postman(webhook_code: str, base_url: Optional[str] = None, filename: Optional[str] = None, package: Optional[str] = None) -> bool |
Export webhook as Postman Collection for API testing. |
| export_to_markdown | export_to_markdown(webhook_code: str, filename: Optional[str] = None, base_url: Optional[str] = None, package: Optional[str] = None) -> bool |
Export webhook as comprehensive Markdown documentation. |
| supplement_inbound_parameters | supplement_inbound_parameters(webhook_code: str) |
Supplements inbound webhook parameters from a |
| supplement_parameters_from_sql | supplement_parameters_from_sql(webhook_code: str) |
Supplements webhook parameters from a SQL query |
Load complete webhook configuration from database.
Delete webhook and all related data from database.
Export webhook to YAML file in local.documents/webhooks/.
Import webhook from YAML file and save to database.
List all webhook YAML files in local.documents/webhooks/.
Export webhook to Postman Collection format.
Export webhook to Markdown documentation format.
Export webhook in all formats (YAML, Postman, Markdown).
Supplements webhook parameters in