Skip to main content
GET
/
api
/
v0
/
zapier
/
subscriptions
/
events
/
{event_kind}
/
sample
Endpoint to return sample data for the Zap editor, helping users test triggers and map fields before activating their Zap.
curl --request GET \
  --url https://api.example.com/api/v0/zapier/subscriptions/events/{event_kind}/sample
import requests

url = "https://api.example.com/api/v0/zapier/subscriptions/events/{event_kind}/sample"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/api/v0/zapier/subscriptions/events/{event_kind}/sample', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v0/zapier/subscriptions/events/{event_kind}/sample",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v0/zapier/subscriptions/events/{event_kind}/sample"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/v0/zapier/subscriptions/events/{event_kind}/sample")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v0/zapier/subscriptions/events/{event_kind}/sample")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
[
  {
    "repositoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "number": 123,
    "title": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "kind": "finding_created",
    "assetGroup": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assets": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
]
{
  "msg": "<string>"
}
{
  "msg": "<string>"
}
{
  "msg": "<string>"
}
{
  "msg": "<string>"
}

Path Parameters

event_kind
enum<string>
required

Kind of event

Available options:
finding_created,
finding_label_added,
finding_comment_created,
finding_updated

Response

List of zapier sample events

Shared payload for finding_created events delivered to external subscribers (Zapier, Clarion). Keeping the shape in one place guarantees both integrations stay in sync when we add or change a field.

repositoryId
string<uuid>
required
id
string<uuid>
required
number
integer<int32>
required
title
string
required
severity
enum<string>
required

Severity of a [Finding].

Available options:
critical,
high,
medium,
low,
informational,
gas_optimization
status
enum<string>
required

Status of a [Finding]. Note that the in_review status is only applicable within bounties.

Available options:
new,
in_review,
disputed,
rejected,
spam,
duplicate,
confirmed,
acknowledged,
fixed,
withdrawn
createdAt
string<date-time>
required
kind
enum<string>
required
Available options:
finding_created
likelihood
null | enum<string>

Likelihood of a [Finding].

Available options:
high,
medium,
low
impact
null | enum<string>

Impact of a [Finding].

Available options:
high,
medium,
low
assetGroup
string<uuid> | null
assets
string<uuid>[] | null