Developer Hub
Request Demo
Request Demo
Support
  1. Webhooks
  • Getting Started
    • Introduction
  • API Reference
    • Admins
      • Bulk Admins Download API (Early Access)
    • Apps
      • Bulk Apps Download API (Early Access)
    • Business Owners
      • Bulk Business Owners Download API (Early Access)
      • Bulk Business Owners Upload API (Early Access)
    • Campaigns
      • Bulk Campaigns Download API (Early Access)
      • Bulk Campaigns Upload API (Early Access)
    • Configuration
      • Bulk Applied Labels Upload API (Early Access)
      • Bulk Entity Finding Rules Download API (Early Access)
      • Bulk Custom Insights (Entity Rules) Download API (Early Access)
      • Bulk Filters Download API (Early Access)
      • Bulk Filters Upload API (Early Access)
      • Bulk Findings Download API (Early Access)
      • Bulk Findings Upload API (Early Access)
      • Bulk Labels Download API (Early Access)
      • Bulk Labels Upload API (Early Access)
      • Bulk Privileged Download API (Early Access)
      • Bulk Privileged Upload API (Early Access)
      • Bulk RBAC Download API (Early Access)
      • Bulk RBAC Upload API (Early Access)
      • Bulk RBAC2 Download API (Early Access)
      • Bulk RBAC2 Upload API (Early Access)
      • Bulk Rules Download API (Early Access)
      • Bulk Rules Upload API (Early Access)
    • Employees
      • Bulk Employees Download API (Early Access)
      • Bulk Employees Upload API (Early Access)
    • Entitlements
      • Bulk Entitlements Download API (Early Access)
      • Bulk Entitlements Upload API (Early Access)
    • Entities
      • Bulk Entities Download API (Early Access)
      • Bulk Entities Upload API (Early Access)
    • EntityInsights
      • Bulk Entity Insights Download API (Early Access)
      • Bulk Entity Insights Upload API (Early Access)
    • EntityRelations
      • Bulk Entity Relations Download API (Early Access)
      • Bulk Entity Relations Upload API (Early Access)
    • EntityRBAC
      • Bulk Entity RBAC Download API
      • Bulk Entity RBAC Upload API
    • Integrations
      • Bulk Integrations Download API (Early Access)
      • Bulk Integrations Upload API (Early Access)
    • Purposes
      • Bulk Purposes Download API (Early Access)
      • Bulk Purposes Upload API (Early Access)
    • Relations
      • Bulk Relations Download API (Early Access)
      • Bulk Relations Upload API (Early Access)
    • Requests
      • Bulk Requests Download API (Early Access)
      • Bulk Requests Upload API (Early Access)
    • Reviews
      • Bulk Reviews Download API (Early Access)
      • Bulk Reviews Upload API (Early Access)
    • Playbooks
      • Bulk Playbook Templates Download API (Early Access)
      • Bulk Playbook Templates API (Early Access)
    • Webhooks
      • Bulk Webhook Templates Download API (Early Access)
        POST
      • Bulk Webhook Templates API (Early Access)
        POST
  • Playbooks
    • Overview
  1. Webhooks

Bulk Webhook Templates API (Early Access)

POST
https://app.balkan.id/api/rest/v0/webhook-templates/upload-url

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:
IDNamDescriptionValueMetadataEntityTypeCreatedByCreatedAtUpdatedByUpdatedAtActiveStatusTypeScopeServer UrlAuth TokenIntegration
01HREEYGKJ70X3MVAG9ZWR192DTemplate 2This is template A{"x2": "some"}some entity2024-03-08 10:00:002024-03-08 12:30:00truefindingintegrationhttps://webhook.site/x124someAuthTokenaws/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 NameColumn Description
IDOptional - A unique identifier for the template.
NameRequired - The name of the template.
DescriptionOptional - A description of the template.
ValueRequired - The value associated with the template.
MetadataOptional - Additional metadata for the template.
EntityTypeRequired - The type of entity associated with the template.
CreatedAtThe timestamp when the template was created.
UpdatedAtThe timestamp when the template was last updated.
ActiveIndicates whether the template is active or not.
StatusIndicates the status of the template.
UpdatedByThe user who last updated the template.
CreatedByThe user who created the template.
TypeRequired The type of webhook. Valid values are: finding, request, review
ScopeRequired The scope of the webhook. Valid values are: integration, global
Server UrlRequired The URL of the webhook.
Auth TokenOptional The authentication token for the webhook.
IntegrationOptional 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

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.balkan.id/api/rest/v0/webhook-templates/upload-url' \
--header 'X-Api-Key-ID;' \
--header 'X-Api-Key-Secret;' \
--header 'Content-Type: application/json'

Responses

🟢200OK
application/json
upload url response
Body

Example
{
    "url": "string"
}
🔴500Server Error
Modified at 2025-04-10 03:44:22
Previous
Bulk Webhook Templates Download API (Early Access)
Next
Overview
Built with