Pistis
API referenceWebhooks

Deliver a code host's webhook

POST
/code-hosts/{connection}/events

Pull request feedback: a review comment, a review that requests changes, a comment that mentions @pistis, or a failing check on a pull request a session opened becomes a message in that session, as the person who wrote it and only if they may message it. Point the code host's webhook here (GitHub: the App's webhook URL) with the connection's webhook secret; the code host signs every delivery. Anything not acted on is recorded with why.

Path Parameters

connection*string

The source control connection's id

Header Parameters

x-hub-signature-256*string

sha256= and the hex HMAC-SHA256 of the raw body with the connection's webhook secret

x-github-delivery*string

Unique per delivery: a repeat is duplicate and does nothing

x-github-event*string

What happened

Request Body

body*unknownapplication/json

Response Body

Sent to the session, recorded and not acted on, or a repeat

application/json
  1. response
outcome*unknown
Example Request
curl -X POST 'http://127.0.0.1:7777/code-hosts/github/events' \  -H 'x-hub-signature-256: sha256=0000' \  -H 'x-github-delivery: d-1' \  -H 'x-github-event: pull_request_review_comment' \  -H 'Content-Type: application/json' \  -d '{  "action": "created"}'
Example Response
{  "outcome": "acted"}

Deliver a webhook POST

Continues every session waiting on `key` (the `wait_for` tool) and starts every flow with `on: { hook: key }`, with the body as the next message. No token: the body is signed with the server's `hookSecret`. GitHub's `x-hub-signature-256` and `x-github-delivery` work as they are.

Check the server is up GET

Next Page