Bulk Playbook Templates Download API (Early Access)

BalkanID Playbook Templates Download CSV Format

In this section, we will explain the BalkanID Playbook Templates CSV format.

Sample CSV

ID	Name	Description	Value	Metadata	EntityType	CreatedAt	UpdatedAt	Active	Recurrence	Scope	Type	Server Url	Integration
AG9ZWR192D	Template 2	This is template A	{"x2": "some"}		2024-03-08 10:00:00		2024-03-08 12:30:00	false	true	integration	finding	https://webhook.site/x124	aws/234

Column Definitions

Column Name	Column Description
ID	Optional - A unique identifier for the template.
Name	Required - The name of the template.
Description	Optional - A description of the template.
Value	Required - The value associated with the template.
EntityType	Required - The type of entity associated with the template.
CreatedAt	The timestamp when the template was created.
UpdatedAt	The timestamp when the template was last updated.
Active	Indicates whether the template is active or not.
Recurrence	Indicates whether the template is recurring or not.
Scope	Required The scope of the webhook. Valid values are: `integration`, `global`
Type	Required The type of webhook. Valid values are: `finding`, `request`, `review`
Server Url	Required The URL of the webhook.
Integration	Optional The integration type of the webhook. required if scope is integration

Download the CSV file via the pre-signed URL

After retrieving the pre-signed URL in the previous step, all that remains is to download the CSV in BalkanID Playbook Templates CSV format from the pre-signed URL.
To use the polling URL, first send an HTTP request with the method HEAD to the pollingUrl.
If the response status code is 404, the file is not ready, and you should retry this polling request after a delay.
If the response status code is 200, the file is ready, and you may proceed to download the CSV from the received url.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

download url response

Body

Download URL endpoint response

pollingUrl

string

required

The value is the polling URL which you will use to poll to find if the data is ready for download.

url

string

required

The value is the download URL from which you will download your CSV file.

Example

{
    "pollingUrl": "string",
    "url": "string"
}

🔴500Server Error

Bulk Playbook Templates Download API (Early Access)

BalkanID Playbook Templates Download CSV Format#

Sample CSV#

Column Definitions#