Deliver response.completed for one Form to a URL (OAuth only)

POST/hooks

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:hooks:write

Request body

requiredapplication/json

formIdstring<uuid>required

targetUrlstring<uri>required

max length 2048

Responses

201

Subscribed. A 410 Gone from targetUrl deletes the hook.

idstring<uuid>

formIdstring<uuid>

targetUrlstring<uri>

createdAtstring<date-time>

400

Invalid body or target URL, or too many subscriptions.

errorstringrequired

Short message; same as message.

codestringrequired

Allowed:invalid_requestunauthorizedinsufficient_scopenot_foundmethod_not_allowedrate_limitedinternal_error

messagestringrequired

hintstringrequired

How to resolve the error.

docsstringrequired

Where the API is described.

401

Missing or invalid token.

errorstringrequired

Short message; same as message.

codestringrequired

Allowed:invalid_requestunauthorizedinsufficient_scopenot_foundmethod_not_allowedrate_limitedinternal_error

messagestringrequired

hintstringrequired

How to resolve the error.

docsstringrequired

Where the API is described.

403

The token lacks the required scope.

errorstringrequired

Short message; same as message.

codestringrequired

Allowed:invalid_requestunauthorizedinsufficient_scopenot_foundmethod_not_allowedrate_limitedinternal_error

messagestringrequired

hintstringrequired

How to resolve the error.

docsstringrequired

Where the API is described.

404

No such Form in this Workspace.

errorstringrequired

Short message; same as message.

codestringrequired

Allowed:invalid_requestunauthorizedinsufficient_scopenot_foundmethod_not_allowedrate_limitedinternal_error

messagestringrequired

hintstringrequired

How to resolve the error.

docsstringrequired

Where the API is described.

429

Rate limited; see the Retry-After header.

errorstringrequired

Short message; same as message.

codestringrequired

Allowed:invalid_requestunauthorizedinsufficient_scopenot_foundmethod_not_allowedrate_limitedinternal_error

messagestringrequired

hintstringrequired

How to resolve the error.

docsstringrequired

Where the API is described.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

formIdstring*targetUrlstring*

Request

curl -X POST 'https://finerlise.com/api/v1/hooks' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
  "targetUrl": "http://example.com"
}'

const response = await fetch("https://finerlise.com/api/v1/hooks", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"formId\": \"126460ed-49b2-4c69-849a-bd8904ec5d8f\",\n  \"targetUrl\": \"http://example.com\"\n}"
});

import requests

response = requests.post(
    "https://finerlise.com/api/v1/hooks",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"formId\": \"126460ed-49b2-4c69-849a-bd8904ec5d8f\",\n  \"targetUrl\": \"http://example.com\"\n}",
)

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
  "targetUrl": "http://example.com",
  "createdAt": "2019-08-24T14:15:22Z"
}

{
  "error": "string",
  "code": "invalid_request",
  "message": "string",
  "hint": "string",
  "docs": "string"
}

{
  "error": "string",
  "code": "invalid_request",
  "message": "string",
  "hint": "string",
  "docs": "string"
}

{
  "error": "string",
  "code": "invalid_request",
  "message": "string",
  "hint": "string",
  "docs": "string"
}

{
  "error": "string",
  "code": "invalid_request",
  "message": "string",
  "hint": "string",
  "docs": "string"
}

{
  "error": "string",
  "code": "invalid_request",
  "message": "string",
  "hint": "string",
  "docs": "string"
}