@@ -823,6 +823,8 @@ async def list_webhooks(
823
823
domain_id : Optional [str ] = None ,
824
824
) -> ListWebhooksResponse :
825
825
"""
826
+ List Webhooks.
827
+ Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
826
828
:param region: Region to target. If none is passed will use default region from the config.
827
829
:param order_by: (Optional) List Webhooks corresponding to specific criteria.
828
830
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
@@ -871,6 +873,8 @@ async def list_webhooks_all(
871
873
domain_id : Optional [str ] = None ,
872
874
) -> List [Webhook ]:
873
875
"""
876
+ List Webhooks.
877
+ Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
874
878
:param region: Region to target. If none is passed will use default region from the config.
875
879
:param order_by: (Optional) List Webhooks corresponding to specific criteria.
876
880
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
@@ -909,6 +913,7 @@ async def get_webhook(
909
913
) -> Webhook :
910
914
"""
911
915
Get information about a Webhook.
916
+ Retrieve information about a specific Webhook using the `webhook_id` and `region` parameters.
912
917
:param webhook_id: ID of the Webhook to check.
913
918
:param region: Region to target. If none is passed will use default region from the config.
914
919
:return: :class:`Webhook <Webhook>`
@@ -944,6 +949,8 @@ async def update_webhook(
944
949
sns_arn : Optional [str ] = None ,
945
950
) -> Webhook :
946
951
"""
952
+ Update a Webhook.
953
+ Update a Webhook events type, SNS ARN or name.
947
954
:param webhook_id: ID of the Webhook to update.
948
955
:param region: Region to target. If none is passed will use default region from the config.
949
956
:param name: Name of the Webhook to update.
@@ -989,6 +996,8 @@ async def delete_webhook(
989
996
region : Optional [Region ] = None ,
990
997
) -> None :
991
998
"""
999
+ Delete a Webhook.
1000
+ You must specify the Webhook you want to delete by the `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be undone.
992
1001
:param webhook_id: ID of the Webhook to delete.
993
1002
:param region: Region to target. If none is passed will use default region from the config.
994
1003
@@ -1028,6 +1037,8 @@ async def list_webhook_events(
1028
1037
domain_id : Optional [str ] = None ,
1029
1038
) -> ListWebhookEventsResponse :
1030
1039
"""
1040
+ List Webhook triggered events.
1041
+ Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
1031
1042
:param webhook_id: ID of the Webhook linked to the events.
1032
1043
:param region: Region to target. If none is passed will use default region from the config.
1033
1044
:param order_by: (Optional) List Webhook events corresponding to specific criteria.
@@ -1090,6 +1101,8 @@ async def list_webhook_events_all(
1090
1101
domain_id : Optional [str ] = None ,
1091
1102
) -> List [WebhookEvent ]:
1092
1103
"""
1104
+ List Webhook triggered events.
1105
+ Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
1093
1106
:param webhook_id: ID of the Webhook linked to the events.
1094
1107
:param region: Region to target. If none is passed will use default region from the config.
1095
1108
:param order_by: (Optional) List Webhook events corresponding to specific criteria.
0 commit comments