List organization webhook deliveries

GET

platform

webhook-deliveries

curl --request GET \
  --url https://api.polymorfa.com/platform/webhook-deliveries \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/platform/webhook-deliveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/webhook-deliveries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": null,
      "eventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "webhookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "attemptCount": 1,
      "capabilities": {
        "retryable": true
      },
      "payloadAvailability": "available",
      "replayableUntil": "2023-11-07T05:31:56Z",
      "metadataExpiresAt": "2023-11-07T05:31:56Z",
      "nextAttemptAt": "2023-11-07T05:31:56Z",
      "lastAttemptAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "lastOutcome": {
        "statusCode": 349,
        "errorCode": "<string>"
      }
    }
  ],
  "page": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

Polymorfa server credential: a scoped pmfa_ organization key, or a pmfa_pt_ project token on project- and session-bound operations inside its exact authenticated project. Keys may be personal or service-account owned. Both enforce selected action scopes; organization keys can address team resources and every project in the organization. Listener and browser client credentials are rejected.

Query Parameters

webhookId

string<uuid>

Identifier for the webhook.

Value constraints

Constraint	Accepted input
Format	`uuid`

eventId

string<uuid>

Identifier for the event.

Value constraints

Constraint	Accepted input
Format	`uuid`

status

enum<string>

Current status of this resource or operation.

Allowed values

Value	Meaning
`pending`	Pending.
`delivering`	Delivering.
`retrying`	Retrying.
`succeeded`	Succeeded.
`failed`	Failed.

Available options:

pending,

delivering,

retrying,

succeeded,

failed

since

string<date-time>

Specifies since for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`

until

string<date-time>

Specifies until for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`

limit

integer

default:25

Specifies limit for this query parameter.

Value constraints

Constraint	Accepted input
Numeric value	`1` through `100` (inclusive)

Required range: 1 <= x <= 100

cursor

string

Specifies cursor for this query parameter.

Response

Success

data

object[]

required

Structured data carried by this object.

Show child attributes

page

object

required

Specifies page for this schema.

Show child attributes

⌘I

List organization webhook deliveries

curl --request GET \
  --url https://api.polymorfa.com/platform/webhook-deliveries \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/platform/webhook-deliveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/webhook-deliveries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": null,
      "eventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "webhookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "attemptCount": 1,
      "capabilities": {
        "retryable": true
      },
      "payloadAvailability": "available",
      "replayableUntil": "2023-11-07T05:31:56Z",
      "metadataExpiresAt": "2023-11-07T05:31:56Z",
      "nextAttemptAt": "2023-11-07T05:31:56Z",
      "lastAttemptAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "lastOutcome": {
        "statusCode": 349,
        "errorCode": "<string>"
      }
    }
  ],
  "page": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

List organization webhook deliveries

Authorizations

Query Parameters

Response