Update a webhook endpoint

PATCH

/webhooks/{id}

curl --request PATCH \
  --url https://postflow.biz.id/api/v1/webhooks/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "example", "events": [ "post.published" ], "active": true }'

Owner only. active: false pauses deliveries.

Authorizations

• apiKey
• oauth

Parameters

Path Parameters

id

required

string

Webhook id

Request Body^required

Media typeapplication/json

object

url

string

<= 500 characters

events

Array<string>

>= 1 items

Allowed values: post.published post.failed post.handoff comment.received message.received account.needs_reconnect

active

boolean

Responses

200

OK

Media typeapplication/json

object

id

required

string

url

required

string

secret

required

Signing secret for X-PostFlow-Signature.

string

events

required

Array<string>

Allowed values: post.published post.failed post.handoff comment.received message.received account.needs_reconnect

active

required

boolean

lastStatus

required

Any of:

integer

HTTP status of the last delivery; 0 = no answer.

integer

null

null

lastError

required

Any of:

string

string

null

null

lastDeliveredAt

required

Any of:

string

string format: date-time

null

null

Example

{
  "events": [
    "post.published"
  ]
}

400

Validation failed. details lists what to fix.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}

401

Missing, invalid, expired or deleted key or token.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}

403

Not allowed: a read-only key, the owner’s approval, or an owner-only action.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}

404

Not found in this workspace.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}

429

More than 120 requests in a minute with this key.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}