v1

latestOpenAPI 3.0.3Apache 2.02026-07-13103980.6 KB

Webhooks

Resolve and Execute a connection webhook

Resolve a webhook based on lookup_id and then execute it

get/webhook/w/{id}/{serviceId}

Path parameters

idstring required

JWT Webhook token that represents the connection lookupId. Signed so we know source came from us

serviceIdstring required

Service provider ID.

Query parameters

estring

The name of downstream event when connector does not supply in body or header

Response

Resolve Webhook

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

request_idstring

UUID of the request received

timestampstring

ISO Datetime webhook event was received

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "data": {
    "timestamp": "2021-10-01T08:26:28.039Z",
    "request_id": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
  },
  "request_id": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef",
  "timestamp": "2021-10-01T08:26:28.039Z"
}