/file/export/rules/webhook/{name}

Exports the information for one or more webhooks to JSON. The information is returned in both a .json file attachment and in the response. The exported information can be imported to a tenant using the /file/import/rules/webhook.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
{
  "text": "Response\n\nAPI-Result\n\n**ruleActions** array of objects\nA collection of objects each containing information about a webhook.\n\n**ruleActions.actions**\tarray of objects\nContains information about the webhook.\n\n**ruleActions..createdBy** string\nThe ID of the user who created the webhook.\n\n**ruleActions.name** string\nThe name provided for the export\n\n**ruleActions..policyId** string\nThe ID of the webhook.\n\n**ruleActions.rule** object\nContains information about the rule (event) that will be used to invoke the webook.\n\n**ruleActions.rule.filter_meta_data**  object\nThe event type.\n\n**ruleActions.rule.filter_meta_data.event_type**   String\nThe name of the event type.\n\n**ruleActions.rule.filter_type** object\nThe type of event filter.\n\n**ruleActions.tenantId** string\nThe ID of the tenant that owns the webhook.\n\n**ruleActions.updatedBy** String\nThe ID of the user who updated the webhook.\n\n**signature**\tstring\n\n**version**\tstring\nThe webhook version.",
  "sidebar": true
}
Path Params
string
required

The base name to assign to the exported file. The endpoint will append ".json" to this name.

Body Params
boolean

Specifies if the webhook's header information should be exported.

boolean

Specifies if the webhooks URL should be exported.

policy_ids
array of strings

The IDs of the webhooks to export. You can get the IDs of each webhook on the tenant by invoking the /rules endpoint.

policy_ids
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json