Skip to content

webhook.md

Latest commit

 

History

History
134 lines (95 loc) · 4.15 KB

webhook.md

File metadata and controls

134 lines (95 loc) · 4.15 KB

Webhook Actions

Details on the various actions that can be performed on the Webhook resource, including the expected parameters and the potential responses.

Contents

Delete

Deletes a webhook

result = client.webhook.delete(
    applicationId=my_application_id,
    webhookId=my_webhook_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, webhook.*, or webhook.delete.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
webhookId string Y ID associated with the webhook 575ed78e7ae143cd83dc4aab
includeWorkflows string N If the workflows that utilize this webhook should also be deleted. true
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Success If webhook was successfully deleted

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if webhook was not found

Get

Retrieves information on a webhook

result = client.webhook.get(
    applicationId=my_application_id,
    webhookId=my_webhook_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, webhook.*, or webhook.get.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
webhookId string Y ID associated with the webhook 575ed78e7ae143cd83dc4aab
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Webhook Webhook information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if webhook was not found

Patch

Updates information about a webhook

result = client.webhook.patch(
    applicationId=my_application_id,
    webhookId=my_webhook_id,
    webhook=my_webhook)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, webhook.*, or webhook.patch.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
webhookId string Y ID associated with the webhook 575ed78e7ae143cd83dc4aab
webhook Webhook Patch Y Object containing new properties of the webhook Webhook Patch Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Webhook Updated webhook information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if webhook was not found