Test Webhook

curl --request POST \
  --url https://app.opencomputer.dev/api/webhooks/{id}/test \
  --header 'X-API-Key: <api-key>'

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.opencomputer.dev/api/webhooks/{id}/test', 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://app.opencomputer.dev/api/webhooks/{id}/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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://app.opencomputer.dev/api/webhooks/{id}/test"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.opencomputer.dev/api/webhooks/{id}/test")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "eventType": "sandbox.created",
  "messageId": "msg_2aB…"
}

POST

api

webhooks

{id}

test

Test Webhook

curl --request POST \
  --url https://app.opencomputer.dev/api/webhooks/{id}/test \
  --header 'X-API-Key: <api-key>'

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.opencomputer.dev/api/webhooks/{id}/test', 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://app.opencomputer.dev/api/webhooks/{id}/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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://app.opencomputer.dev/api/webhooks/{id}/test"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.opencomputer.dev/api/webhooks/{id}/test")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "eventType": "sandbox.created",
  "messageId": "msg_2aB…"
}

Enqueue a sample event to exercise your endpoint. It sends a real, signed message of a concrete type the destination is subscribed to (the first of its eventTypes, defaulting to sandbox.created), carrying the normal delivery envelope with event.data.test = true — so you exercise your real verifier and parser. Delivery is asynchronous — this returns once the message is accepted; check deliveries for the outcome.

The sample is published through your org’s webhook app, so it is not isolated to this one destination: any other destination subscribed to the same event type (and matching scope) also receives it (likewise marked event.data.test = true).

See Webhooks.

string

required

Destination ID (whk_…).

{
  "ok": true,
  "eventType": "sandbox.created",
  "messageId": "msg_2aB…"
}

messageId is the delivery’s message id — find its attempt under deliveries.

⌘I

Getting Started

Sandboxes

Browser Sessions

Durable Agent Sessions

Reserved Capacity

CLI

Guides

TypeScript SDK

Python SDK

CLI Reference

API Reference

Resources

Test Webhook