Update a destination

PATCH

/v1/destinations/{id}

const url = 'https://api.hooks.events/v1/destinations/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","url":"example","headers":{"additionalProperty":"example"},"timeoutMs":1,"retryPolicy":{"maxAttempts":1,"initialDelaySeconds":1,"maxDelaySeconds":1,"backoff":"fixed","jitter":1,"retryAfter":true},"rateLimitPerMinute":1,"maxConcurrency":1,"status":"active","type":"example","config":{"additionalProperty":"example"},"method":"GET","params":[{"key":"example","value":"example","enabled":true}],"auth":{"mode":"none","token":"example","username":"example","password":"example","key":"example","value":"example","addTo":"header","secret":"example","header":"example","tokenUrl":"example","clientId":"example","clientSecret":"example","scope":"example"},"bodyMode":"none","bodyTemplate":"example","templateStrict":true,"filters":{"allow":[{"field":"example","op":"equals","value":["example"]}],"deny":[{"field":"example","op":"equals","value":["example"]}],"ignoreActors":["example"],"ignoreBots":true,"senders":{"allow":{"logins":["example"],"organizations":["example"],"associations":["OWNER"]},"requireAllowlist":true,"allowForkPrs":true,"frequency":{"max":1,"windowMinutes":1,"key":"actor"}}},"hooks":{"stages":{"received":[{"type":"drop","condition":{"field":"example","op":"equals","value":["example"]}}],"before_transform":[{"type":"drop","condition":{"field":"example","op":"equals","value":["example"]}}],"before_deliver":[{"type":"drop","condition":{"field":"example","op":"equals","value":["example"]}}],"after_deliver":[{"type":"drop","condition":{"field":"example","op":"equals","value":["example"]}}],"on_failure":[{"type":"drop","condition":{"field":"example","op":"equals","value":["example"]}}],"on_dead":[{"type":"drop","condition":{"field":"example","op":"equals","value":["example"]}}]}},"transform":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.hooks.events/v1/destinations/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "url": "example", "headers": { "additionalProperty": "example" }, "timeoutMs": 1, "retryPolicy": { "maxAttempts": 1, "initialDelaySeconds": 1, "maxDelaySeconds": 1, "backoff": "fixed", "jitter": 1, "retryAfter": true }, "rateLimitPerMinute": 1, "maxConcurrency": 1, "status": "active", "type": "example", "config": { "additionalProperty": "example" }, "method": "GET", "params": [ { "key": "example", "value": "example", "enabled": true } ], "auth": { "mode": "none", "token": "example", "username": "example", "password": "example", "key": "example", "value": "example", "addTo": "header", "secret": "example", "header": "example", "tokenUrl": "example", "clientId": "example", "clientSecret": "example", "scope": "example" }, "bodyMode": "none", "bodyTemplate": "example", "templateStrict": true, "filters": { "allow": [ { "field": "example", "op": "equals", "value": [ "example" ] } ], "deny": [ { "field": "example", "op": "equals", "value": [ "example" ] } ], "ignoreActors": [ "example" ], "ignoreBots": true, "senders": { "allow": { "logins": [ "example" ], "organizations": [ "example" ], "associations": [ "OWNER" ] }, "requireAllowlist": true, "allowForkPrs": true, "frequency": { "max": 1, "windowMinutes": 1, "key": "actor" } } }, "hooks": { "stages": { "received": [ { "type": "drop", "condition": { "field": "example", "op": "equals", "value": [ "example" ] } } ], "before_transform": [ { "type": "drop", "condition": { "field": "example", "op": "equals", "value": [ "example" ] } } ], "before_deliver": [ { "type": "drop", "condition": { "field": "example", "op": "equals", "value": [ "example" ] } } ], "after_deliver": [ { "type": "drop", "condition": { "field": "example", "op": "equals", "value": [ "example" ] } } ], "on_failure": [ { "type": "drop", "condition": { "field": "example", "op": "equals", "value": [ "example" ] } } ], "on_dead": [ { "type": "drop", "condition": { "field": "example", "op": "equals", "value": [ "example" ] } } ] } }, "transform": "example" }'

Requires the endpoints:write scope.

Authorizations

apiKey
sessionCookie

Parameters

Path Parameters

required

string

Request Body^required

application/json

object

name

string

>= 1 characters <= 60 characters

url

string

<= 2000 characters

headers

object

key

additional properties

string | null

timeoutMs

integer

>= 100 <= 30000

retryPolicy

Any of:

object
null

object

maxAttempts

integer

>= 1 <= 10

initialDelaySeconds

integer

>= 1 <= 60

maxDelaySeconds

integer

>= 5 <= 3600

backoff

string

Allowed values: fixed exponential

jitter

number

<= 0.5

retryAfter

boolean

rateLimitPerMinute

Any of:

integer
null

integer

>= 1 <= 100000

maxConcurrency

Any of:

integer
null

integer

>= 1 <= 100

status

string

Allowed values: active paused

type

string

>= 1 characters <= 50 characters

config

object

key

additional properties

method

string

Allowed values: GET POST PUT PATCH DELETE

params

Array<object>

<= 20 items

object

key

required

string

>= 1 characters <= 100 characters

value

required

string

<= 2000 characters

enabled

boolean

auth

object

mode

string

Allowed values: none bearer basic apikey hmac oauth2

token

string

<= 4000 characters

username

string

<= 500 characters

password

string

<= 500 characters

key

string

<= 100 characters

value

string

<= 4000 characters

addTo

string

Allowed values: header query

secret

string

<= 1000 characters

header

string

<= 100 characters

tokenUrl

string

<= 2000 characters

clientId

string

<= 500 characters

clientSecret

string

<= 1000 characters

scope

string

<= 500 characters

bodyMode

string

Allowed values: none json form raw binary multipart

bodyTemplate

string

<= 100000 characters

templateStrict

boolean

filters

Any of:

object
null

object

allow

Array

<= 20 items

Any of:

object

field

required

string

>= 1 characters <= 200 characters

required

string

Allowed values: equals not_equals in contains matches exists

value

Any of:

string

<= 1000 characters

deny

Array

<= 20 items

Any of:

object

field

required

string

>= 1 characters <= 200 characters

required

string

Allowed values: equals not_equals in contains matches exists

value

Any of:

string

<= 1000 characters

ignoreActors

Array<string>

<= 20 items

ignoreBots

boolean

senders

object

allow

object

logins

Array<string>

>= 1 items <= 50 items

organizations

Array<string>

>= 1 items <= 20 items

associations

Array<string>

>= 1 items <= 6 items

Allowed values: OWNER MEMBER COLLABORATOR CONTRIBUTOR FIRST_TIME_CONTRIBUTOR NONE

requireAllowlist

boolean

allowForkPrs

boolean

frequency

object

max

required

integer

>= 1 <= 1000

windowMinutes

required

integer

>= 1 <= 1440

key

string

Allowed values: actor subject

hooks

Any of:

object
null

object

stages

required

object

received

Array

<= 10 items

One of:

object

type

required

string

Allowed value: drop

condition

Any of:

object

field

required

string

>= 1 characters <= 200 characters

required

string

Allowed values: equals not_equals in contains matches exists

value

Any of:

string

<= 1000 characters

before_transform

Array

<= 10 items

One of:

object

type

required

string

Allowed value: drop

condition

Any of:

object

field

required

string

>= 1 characters <= 200 characters

required

string

Allowed values: equals not_equals in contains matches exists

value

Any of:

string

<= 1000 characters

before_deliver

Array

<= 10 items

One of:

object

type

required

string

Allowed value: drop

condition

Any of:

object

field

required

string

>= 1 characters <= 200 characters

required

string

Allowed values: equals not_equals in contains matches exists

value

Any of:

string

<= 1000 characters

after_deliver

Array

<= 10 items

One of:

object

type

required

string

Allowed value: drop

condition

Any of:

object

field

required

string

>= 1 characters <= 200 characters

required

string

Allowed values: equals not_equals in contains matches exists

value

Any of:

string

<= 1000 characters

on_failure

Array

<= 10 items

One of:

object

type

required

string

Allowed value: drop

condition

Any of:

object

field

required

string

>= 1 characters <= 200 characters

required

string

Allowed values: equals not_equals in contains matches exists

value

Any of:

string

<= 1000 characters

on_dead

Array

<= 10 items

One of:

object

type

required

string

Allowed value: drop

condition

Any of:

object

field

required

string

>= 1 characters <= 200 characters

required

string

Allowed values: equals not_equals in contains matches exists

value

Any of:

string

<= 1000 characters

transform

Any of:

string
null

string

<= 20000 characters

Responses

200

Success

application/json

object

required

boolean

key

additional properties

Example ^generated

{
  "ok": true
}

400

Validation error

application/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

401

Missing or invalid credentials

application/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

403

The credential lacks the required scope, or the workspace is not writable

application/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

404

Resource not found

application/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

429

Rate limited

application/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

Headers

X-RateLimit-Limit

integer

Requests allowed per window

X-RateLimit-Remaining

integer

X-RateLimit-Reset

integer

Seconds until the window resets

Update a destination

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

Example generated

400

Example generated

401

Example generated

403

Example generated

404

Example generated

429

Example generated

Headers

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated