Create a project webhook

curl --request POST \
  --url https://api.ionworks.com/projects/{project_id}/webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [],
  "enabled": true
}
'

import requests

url = "https://api.ionworks.com/projects/{project_id}/webhooks"

payload = {
    "url": "<string>",
    "events": [],
    "enabled": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>', events: [], enabled: true})
};

fetch('https://api.ionworks.com/projects/{project_id}/webhooks', 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.ionworks.com/projects/{project_id}/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'events' => [
        
    ],
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.ionworks.com/projects/{project_id}/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"events\": [],\n  \"enabled\": true\n}")

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

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.ionworks.com/projects/{project_id}/webhooks")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"events\": [],\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ionworks.com/projects/{project_id}/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"events\": [],\n  \"enabled\": true\n}"

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

{
  "id": "<string>",
  "project_id": "<string>",
  "organization_id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "secret": "<string>",
  "consecutive_failures": 0,
  "disabled_reason": "<string>",
  "created_by": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Create a project webhook

curl --request POST \
  --url https://api.ionworks.com/projects/{project_id}/webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [],
  "enabled": true
}
'

import requests

url = "https://api.ionworks.com/projects/{project_id}/webhooks"

payload = {
    "url": "<string>",
    "events": [],
    "enabled": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>', events: [], enabled: true})
};

fetch('https://api.ionworks.com/projects/{project_id}/webhooks', 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.ionworks.com/projects/{project_id}/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'events' => [
        
    ],
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.ionworks.com/projects/{project_id}/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"events\": [],\n  \"enabled\": true\n}")

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

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.ionworks.com/projects/{project_id}/webhooks")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"events\": [],\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ionworks.com/projects/{project_id}/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"events\": [],\n  \"enabled\": true\n}"

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

{
  "id": "<string>",
  "project_id": "<string>",
  "organization_id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "secret": "<string>",
  "consecutive_failures": 0,
  "disabled_reason": "<string>",
  "created_by": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

project_id

string

required

Body

application/json

Request body for creating a project webhook.

url

string

required

HTTPS destination URL.

events

enum<string>[]

required

Events that should trigger delivery.

Minimum array length: 1

Supported webhook events (namespaced by resource family).

Add new members as more resources gain webhook fire points. Validation lives in the API layer; the DB does not hard-code the allowed set.

Available options:

pipeline.completed,

pipeline.failed,

pipeline.canceled,

simple_pipeline.completed,

simple_pipeline.failed,

simple_pipeline.canceled,

cell_specification.created,

cell_specification.updated,

cell_specification.deleted,

cell_instance.created,

cell_instance.updated,

cell_instance.deleted,

cell_measurement.created,

cell_measurement.updated,

cell_measurement.deleted

enabled

boolean

default:true

Whether the webhook is active.

Response

Successful Response

Create response that includes the signing secret once.

string

required

project_id

string

required

organization_id

string

required

url

string

required

events

string[]

required

enabled

boolean

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

secret

string

required

HMAC signing secret; shown only in the create response.

consecutive_failures

integer

default:0

disabled_reason

string | null

created_by

string | null

⌘I

API Reference

Cell Specifications

Cell Instances

Cell Measurements

Programs

Sites

Cyclers

Channels

Thermal chambers

Simulations

parameterized_models

discovery

Pipeline

simple_pipeline

protocols

users

jobs

optimization

optimizations

Organizations

project-webhooks

studies

Lab

Planned Measurements

Health check

Create a project webhook

Path Parameters

Body

Response