Skip to content
PayloadPuffin.
Join the waitlist

GET/v1/sourcespreview

List the sources of the app. Deleted sources are left out.

Returns

200

The query result.

  • data object[] Required

    Sources, newest first.

    • id string Required

      A source ID, starting with src_.

    • name string Required

      Human-readable label for the source, such as the provider that sends to it.

      1 to 120 characters

    • url string Required

      The source’s URL without its token. Requests go to this URL followed by / and the token, which is shown only when the source is created or its token rotated.

    • tokenLast4 string Required

      The last four characters of the token.

    • defaultType string Required

      The type of every event this source receives, for example billing.webhook.

      1 to 64 characters

    • defaultChannels string[] Required

      Channels every event this source receives is addressed to. Empty: the events reach only destinations that list no channel. Stored sorted, without duplicates.

      At most 10 items

    • signed boolean Required

      True when every request must carry a valid HMAC signature.

    • storeUnverified boolean Required

      True when a request that fails the signature check is stored as an unbuilt event instead of refused. False for a source without a signature.

    • lastEventAt string | null Required

      When this source last received a request that became an event, to the minute. Null when there is none.

  • links object Required

    Links for navigating a paginated collection.

    • next string | null Required

      URI reference for the next page, or null at the end.

Example

Request
curl -X GET "https://api.payloadpuffin.com/v1/sources" \
  -H "Authorization: Bearer $PAYLOADPUFFIN_API_KEY"
Response 200
{
  "data": [
    {
      "id": "id",
      "name": "name",
      "url": "url",
      "tokenLast4": "tokenLast4",
      "defaultType": "defaultType",
      "defaultChannels": [
        "defaultChannels"
      ],
      "signed": true,
      "storeUnverified": true,
      "lastEventAt": "lastEventAt"
    }
  ],
  "links": {
    "next": "next"
  }
}

Errors

Errors use application/problem+json. The code member is stable; branch on it rather than on title or detail.

  • 4XX application/problem+json

    The request was rejected.