Skip to content
PayloadPuffin.
Join the waitlist

Remove the POST URL check of a source

DELETE/v1/sources/{sourceId}/body-challengepreview

Stop answering the POST URL check. A repeat changes nothing.

Path parameters

  • sourceId string Required

    A source ID, starting with src_.

Returns

200

The command completed.

  • data object Required

    A source: a URL a webhook provider sends requests to, each of which becomes an event.

    • 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.

    • previousTokenExpiresAt string | null Required

      When the token a rotation replaced stops working. Null when there is none.

    • 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

    • signature object | null Required

      The HMAC check every request must pass. Null: the source is URL only.

    • queryChallenge object | null Required

      The GET URL check. Null: none.

    • bodyChallenge object | null Required

      The POST URL check. Null: none.

    • transformId string | null Required

      The transform that builds every event. Null: a JSON body becomes the payload as received.

    • createdAt string (date-time) Required

      ISO 8601 timestamp.

    • updatedAt string (date-time) Required

      ISO 8601 timestamp.

    • lastEventAt string | null Required

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

Example

Request
curl -X DELETE "https://api.payloadpuffin.com/v1/sources/$SOURCEID/body-challenge" \
  -H "Authorization: Bearer $PAYLOADPUFFIN_API_KEY"
Response 200
{
  "data": {
    "id": "id",
    "name": "name",
    "url": "url",
    "tokenLast4": "tokenLast4",
    "previousTokenExpiresAt": "previousTokenExpiresAt",
    "defaultType": "defaultType",
    "defaultChannels": [
      "defaultChannels"
    ],
    "signature": {
      "algorithm": "sha256",
      "header": "header",
      "encoding": "hex",
      "secretEncoding": "text",
      "delimiter": "delimiter",
      "prefix": "prefix",
      "timestamp": {
        "header": "header",
        "prefix": "prefix",
        "toleranceSeconds": 1
      },
      "signedContent": "signedContent",
      "storeUnverified": true,
      "previousSecretExpiresAt": "previousSecretExpiresAt"
    },
    "queryChallenge": {
      "tokenParameter": "tokenParameter",
      "token": "token",
      "challengeParameter": "challengeParameter"
    },
    "bodyChallenge": {
      "member": "member",
      "value": "value",
      "echo": "echo"
    },
    "transformId": "transformId",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "lastEventAt": "lastEventAt"
  }
}

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.