List webhook endpoints

GET

/webhooks

const url = 'https://postflow.biz.id/api/v1/webhooks';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://postflow.biz.id/api/v1/webhooks \
  --header 'Authorization: Bearer <token>'

Owner only.

Authorizations

apiKey
oauth

Responses

200

application/json

Array<object>

object

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
null

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

integer

lastError

required

Any of:

string
null

string

lastDeliveredAt

required

Any of:

string
null

string format: date-time

Example

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

401

Missing, invalid, expired or deleted key or token.

application/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.

application/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.

application/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"
  }
}