Change a webhook

curl --request PATCH \
  --url https://api.pomerado.ai/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": []
}
'

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

fetch('https://api.pomerado.ai/v1/webhooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.pomerado.ai/v1/webhooks/{id}"

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

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

print(response.text)

{
  "id": "wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190",
  "created_by": {
    "user_id": "<string>",
    "email": "<string>"
  },
  "url": "<string>",
  "events": [
    "job.needs_input"
  ],
  "status": "active",
  "disabled_reason": "manual",
  "created_at": "<string>",
  "last_delivery_at": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

Webhooks

Change a webhook

Change one of your webhooks’ URL or events, or turn it off or on again; another member’s is forbidden. A webhook turns itself off when its receiver answers 410 or fails 20 deliveries in a row; status active turns it back on and clears its failures. Events: job.needs_input (a job asks a question; the payload has its screened questions and the page where you answer), job.input_expiring (three minutes left to answer), job.succeeded and job.failed (a job settled). No event carries a result: read it from the job through the client that started it.

PATCH

webhooks

{id}

Change a webhook

curl --request PATCH \
  --url https://api.pomerado.ai/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": []
}
'

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

fetch('https://api.pomerado.ai/v1/webhooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.pomerado.ai/v1/webhooks/{id}"

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

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

print(response.text)

{
  "id": "wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190",
  "created_by": {
    "user_id": "<string>",
    "email": "<string>"
  },
  "url": "<string>",
  "events": [
    "job.needs_input"
  ],
  "status": "active",
  "disabled_reason": "manual",
  "created_at": "<string>",
  "last_delivery_at": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

a webhook ID: wh_ and 32 lowercase hex digits

Example:

"wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"

Body

application/json

url

string

events

enum<string>[]

an array of at least 1 item(s)

Minimum array length: 1

Available options:

job.needs_input,

job.input_expiring,

job.succeeded,

job.failed

status

enum<string>

active turns a disabled webhook on again and clears its failures; disabled turns it off

Available options:

active,

disabled

Response

The changed webhook

string

required

a webhook ID: wh_ and 32 lowercase hex digits

Example:

"wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"

created_by

object

required

The member who made the webhook: only they change, test and rotate it, and it carries the events of the jobs they could see

Show child attributes

url

string

required

events

enum<string>[]

required

Available options:

job.needs_input,

job.input_expiring,

job.succeeded,

job.failed

status

enum<string>

required

Available options:

active,

disabled

disabled_reason

enum<string> | null

required

Why a disabled webhook sends nothing: manual (turned off), gone (its receiver answered 410), unreachable (20 failed deliveries in a row) or secret_unreadable (rotate its secret)

Available options:

manual,

gone,

unreachable,

secret_unreadable

created_at

string

required

a string to be decoded into a Date

last_delivery_at

string | null

required

a string to be decoded into a Date

Overview

Endpoints

Change a webhook

Authorizations

Path Parameters

Body

Response