Create external event

Inbound provider webhook. The raw JSON body is verified with HMAC-SHA256 against the source’s mapping secret — send the hex digest in any *-signature header (X-Pile-Signature, Finix-Signature, sha256=<hex>, or t=…,v1=<hex> envelopes all work). The provider event id for dedupe comes from a *-Event-Id header or the payload’s id field.

POST/workspaces/{organizationId}/external-events/{source}

Path parameters

organizationIdstringrequired

sourcestringrequired

Request body

application/json

object

Responses

200

Event received and recorded

okbooleanrequired

statusstringrequired

deliveryIdstring

outcomestring

completedIssueIdsstring[]

401

Invalid webhook signature

404

External event source not configured

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*sourcepath*

Bodyapplication/json

Request body

Request

curl -X POST '/workspaces/string/external-events/string' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "property1": null,
  "property2": null
}'

const response = await fetch("/workspaces/string/external-events/string", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"property1\": null,\n  \"property2\": null\n}"
});

import requests

response = requests.post(
    "/workspaces/string/external-events/string",
    headers={
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"property1\": null,\n  \"property2\": null\n}",
)

Response

{
  "ok": true,
  "status": "string",
  "deliveryId": "string",
  "outcome": "string",
  "completedIssueIds": [
    "string"
  ]
}