Skip to content
spirby spirby docs

Update a webhook (toggle enabled, change url or events)

PATCH
/v1/webhooks/{webhookId}
 
curl --request PATCH \
  --url https://api.spirby.com/v1/webhooks/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "events": [ "post.created" ], "url": "example" }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
webhookId
required
string
>= 1 characters

Request Body

Section titled “Request Body ”
Media type application/json
object
enabled
boolean
events
Array<string>
>= 1 items
Allowed values: post.created post.status_changed vote.created comment.created changelog.published
url
string
>= 1 characters <= 2048 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful response

Media type application/json
object
data
Example generated
{
  "data": "example"
}

401

Section titled “401 ”

Missing or invalid API key

Media type application/json
object
error
required
object
code
required
string
details
object
key
additional properties
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "details": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}

403

Section titled “403 ”

Scope insufficient (ERR_SCOPE_INSUFFICIENT) or org in readonly billing state (ERR_FORBIDDEN)

Media type application/json
object
error
required
object
code
required
string
details
object
key
additional properties
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "details": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}

422

Section titled “422 ”

Validation failed

Media type application/json
object
error
required
object
code
required
string
details
object
key
additional properties
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "details": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}

429

Section titled “429 ”

Rate limit exceeded

Media type application/json
object
error
required
object
code
required
string
details
object
key
additional properties
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "details": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}

500

Section titled “500 ”

Internal error

Media type application/json
object
error
required
object
code
required
string
details
object
key
additional properties
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "details": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}