Update signal

Update one UI-managed Outlit automation signal with a full signal configuration body.

PATCH /api/signals/{id}

Update signal

cURL

curl --request PATCH \
  --url https://app.outlit.ai/api/signals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "EVENT_MATCH",
  "name": "Workspace inactive",
  "description": null,
  "definition": {
    "grain": "customer",
    "subjectResolver": "event_customer",
    "eventNames": [
      "workspace_inactive"
    ],
    "propertyConditions": [],
    "conditionMode": "ALL"
  }
}
'

import requests

url = "https://app.outlit.ai/api/signals/{id}"

payload = {
    "kind": "EVENT_MATCH",
    "name": "Workspace inactive",
    "description": None,
    "definition": {
        "grain": "customer",
        "subjectResolver": "event_customer",
        "eventNames": ["workspace_inactive"],
        "propertyConditions": [],
        "conditionMode": "ALL"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    kind: 'EVENT_MATCH',
    name: 'Workspace inactive',
    description: null,
    definition: {
      grain: 'customer',
      subjectResolver: 'event_customer',
      eventNames: ['workspace_inactive'],
      propertyConditions: [],
      conditionMode: 'ALL'
    }
  })
};

fetch('https://app.outlit.ai/api/signals/{id}', 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.outlit.ai/api/signals/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'kind' => 'EVENT_MATCH',
    'name' => 'Workspace inactive',
    'description' => null,
    'definition' => [
        'grain' => 'customer',
        'subjectResolver' => 'event_customer',
        'eventNames' => [
                'workspace_inactive'
        ],
        'propertyConditions' => [
                
        ],
        'conditionMode' => 'ALL'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://app.outlit.ai/api/signals/{id}"

	payload := strings.NewReader("{\n  \"kind\": \"EVENT_MATCH\",\n  \"name\": \"Workspace inactive\",\n  \"description\": null,\n  \"definition\": {\n    \"grain\": \"customer\",\n    \"subjectResolver\": \"event_customer\",\n    \"eventNames\": [\n      \"workspace_inactive\"\n    ],\n    \"propertyConditions\": [],\n    \"conditionMode\": \"ALL\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://app.outlit.ai/api/signals/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"kind\": \"EVENT_MATCH\",\n  \"name\": \"Workspace inactive\",\n  \"description\": null,\n  \"definition\": {\n    \"grain\": \"customer\",\n    \"subjectResolver\": \"event_customer\",\n    \"eventNames\": [\n      \"workspace_inactive\"\n    ],\n    \"propertyConditions\": [],\n    \"conditionMode\": \"ALL\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.outlit.ai/api/signals/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"kind\": \"EVENT_MATCH\",\n  \"name\": \"Workspace inactive\",\n  \"description\": null,\n  \"definition\": {\n    \"grain\": \"customer\",\n    \"subjectResolver\": \"event_customer\",\n    \"eventNames\": [\n      \"workspace_inactive\"\n    ],\n    \"propertyConditions\": [],\n    \"conditionMode\": \"ALL\"\n  }\n}"

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

200

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 123,
  "correlationId": "<string>",
  "result": {
    "operationId": "<string>",
    "status": "<string>",
    "resources": [
      {
        "type": "<string>",
        "id": "<string>"
      }
    ],
    "data": {
      "signal": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "<string>",
        "name": "<string>",
        "description": "<string>",
        "definition": "<unknown>",
        "schemaVersion": "<string>",
        "configHash": "<string>",
        "archivedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    },
    "warnings": [
      "<string>"
    ],
    "auditId": "<string>"
  }
}

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

{
  "error": "Invalid credentials"
}

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

{
  "error": "Internal server error"
}

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

Authorizations

Authorization · string · header · required

Outlit API key using the Bearer ok_... format.

Path Parameters

id · string<uuid> · required

Signal ID.

Body

application/json

Option 1

Option 2

kind · string · required

Allowed value: "EVENT_MATCH"

name · string · required

Required string length: 1 - 120

definition · object · required

Show child attributes

description · string | null

Maximum string length: 1000

Response

200

application/json

Signal was updated.

ok · boolean · required

commandId · string · required

Allowed value: "signal.update"

commandVersion · integer · required

correlationId · string · required

result · object · required

Show child attributes