Bulk Webhook Templates API (Early Access)

BalkanID Webhook Templates Upload CSV Format

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

Sample CSV

Here is a sample of the BalkanID Webhook Templates CSV format:

ID	Nam	Description	Value	Metadata	EntityType	CreatedBy	CreatedAt	UpdatedBy	UpdatedAt	Active	Status	Type	Scope	Server Url	Auth Token	Integration
01HREEYGKJ70X3MVAG9ZWR192D	Template 2	This is template A	{"x2": "some"}		some entity		2024-03-08 10:00:00		2024-03-08 12:30:00	true		finding	integration	https://webhook.site/x124	someAuthToken	aws/234

The CSV follows the structure outlined above. It contains various fields such as ID, Employee, Identity, Labels, Integration, Name, Description, Value, Metadata, Reason, Assigned To, Updated At, and Updated By.

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.
Metadata	Optional - Additional metadata for 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.
Status	Indicates the status of the template.
UpdatedBy	The user who last updated the template.
CreatedBy	The user who created the template.
Type	Required The type of webhook. Valid values are: `finding`, `request`, `review`
Scope	Required The scope of the webhook. Valid values are: `integration`, `global`
Server Url	Required The URL of the webhook.
Auth Token	Optional The authentication token for the webhook.
Integration	Optional The integration type of the webhook. required if scope is integration

Upload the CSV file via the pre-signed URL

After retrieving the pre-signed URL in the previous step, all that remains is to upload the CSV in BalkanID Webhook Templates CSV format to the pre-signed URL.
Below is a summary of the request using curl:

The request URL is the pre-signed URL from previous step.

The request method is PUT.

Required request body is the CSV in BalkanID Webhook Templates CSV format.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

upload url response

Body

Upload URL endpoint response

url

string

required

The value is the pre-signed URL to which to upload your CSV file.

Example

{
    "url": "string"
}

Bulk Webhook Templates API (Early Access)

BalkanID Webhook Templates Upload CSV Format#

Sample CSV#

Column Definitions#

Upload the CSV file via the pre-signed URL#

Request

Request samples

Responses

BalkanID Webhook Templates Upload CSV Format

Sample CSV

Column Definitions

Upload the CSV file via the pre-signed URL