Send a test delivery

POST/api/v1/webhooks/{id}/test

Authorization

AuthorizationOAuth2 access token · headerrequired

OAuth 2.1 authorization code flow with PKCE. Audience must be the connect URL.

Scopes:torqee:webhooks:write

AuthorizationBearer token · headerrequired

Workspace API key issued from the torqee web app. Pass the torqee_-prefixed key as the bearer token. API keys carry the same read scopes as OAuth tokens.

Path parameters

idstringrequired

min length 1

Responses

202

Test delivery queued

idstringrequired

min length 1

eventIdstringrequired

min length 1

eventTypestringrequired

Allowed:session.createdsession.status_changed

endpointIdstringrequired

min length 1

endpointNamestringrequired

min length 1

endpointUrlstring<uri>required

kindstringrequired

Allowed:eventtestreplay

statusstringrequired

Allowed:pendingretryingsucceededdead_lettercancelled

attemptCountintegerrequired

min 0 · max 9007199254740991

lastHttpStatusinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

nextAttemptAtstring<date-time> | nullrequired

Show properties

Any of:

string<date-time>

string<date-time>

null

null

terminalAtstring<date-time> | nullrequired

Show properties

Any of:

string<date-time>

string<date-time>

null

null

stopReasonstring | null

Show properties

Any of:

string

string

null

null

createdAtstring<date-time>required

matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

updatedAtstring<date-time>required

401

Missing or invalid credentials

errorstringrequired

Allowed:unauthorized

403

Membership revoked or insufficient scope

errorstringrequired

Allowed:insufficient_scopeforbidden

404

Webhook endpoint or workspace not found

errorstringrequired

Allowed:not_foundworkspace_not_found

500

Unexpected server error

errorstringrequired

Allowed:internal_server_error

503

Delivery service unavailable

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

idpath*

Request

curl -X POST 'https://connect.torqee.app/api/v1/webhooks/string/test' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://connect.torqee.app/api/v1/webhooks/string/test", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.post(
    "https://connect.torqee.app/api/v1/webhooks/string/test",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "id": "string",
  "eventId": "string",
  "eventType": "session.created",
  "endpointId": "string",
  "endpointName": "string",
  "endpointUrl": "http://example.com",
  "kind": "event",
  "status": "pending",
  "attemptCount": 0,
  "lastHttpStatus": 100,
  "nextAttemptAt": "2019-08-24T14:15:22Z",
  "terminalAt": "2019-08-24T14:15:22Z",
  "stopReason": "installation_unauthorized",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": "unauthorized"
}

{
  "error": "insufficient_scope"
}

{
  "error": "not_found"
}

{
  "error": "internal_server_error"
}