SecurityAgent / Client / update_integration

update_integration¶

SecurityAgent.Client.update_integration(**kwargs)¶

Creates an integration’s webhook, or rotates the HMAC signing secret of an existing one. The secret is returned only once, in this response, and cannot be retrieved again.

Request Syntax

response = client.update_integration(
    integrationId='string',
    webhookAction='CREATE_IF_ABSENT'|'ROTATE'
)

Parameters:

integrationId (string) –
[REQUIRED]

The ID of the integration whose webhook you want to create or rotate.
webhookAction (string) –
[REQUIRED]

The action to perform on the integration’s webhook.

Return type:

dict

Returns:

Response Syntax

{
    'integrationId': 'string',
    'webhookUrl': 'string',
    'secret': 'string'
}

Response Structure

(dict) –

Output for the UpdateIntegration operation.
- integrationId (string) –
  
  The ID of the integration.
- webhookUrl (string) –
  
  The payload URL to configure on your provider instance. Returned when a webhook is created; unchanged by a rotate.
- secret (string) –
  
  The HMAC signing secret for the webhook. Returned only once, in this response; it is never returned again.

Exceptions

SecurityAgent.Client.exceptions.ResourceNotFoundException
SecurityAgent.Client.exceptions.InternalServerException
SecurityAgent.Client.exceptions.ValidationException
SecurityAgent.Client.exceptions.ConflictException
SecurityAgent.Client.exceptions.ThrottlingException
SecurityAgent.Client.exceptions.AccessDeniedException