Claim Hooks

Creates a claim hook

post

This route creates a claim hook. Claim hooks are an atomic action that will be performed when a boost is claimed

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

hookone ofRequired

or

or

Responses

200

Successful response

application/json

stringOptional

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/claim-hook/create

HTTPcURLJavaScriptPython

POST /api/claim-hook/create HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 391

{
  "hook": {
    "type": "text",
    "data": {
      "claimUri": "text",
      "targetUri": "text",
      "permissions": {
        "role": "text",
        "canView": true,
        "canEdit": true,
        "canIssue": true,
        "canRevoke": true,
        "canManagePermissions": true,
        "canIssueChildren": "text",
        "canCreateChildren": "text",
        "canEditChildren": "text",
        "canRevokeChildren": "text",
        "canManageChildrenPermissions": "text",
        "canManageChildrenProfiles": true,
        "canViewAnalytics": true
      }
    }
  }
}

text

Gets Claim Hooks

post

This route gets claim hooks attached to a given boost

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

uristringRequired

Responses

200

Successful response

application/json

cursorstringOptional

hasMorebooleanRequired

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/claim-hook/get

HTTPcURLJavaScriptPython

POST /api/claim-hook/get HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 446

{
  "limit": 25,
  "cursor": "text",
  "sort": "text",
  "query": {
    "type": "text",
    "data": {
      "claimUri": "text",
      "targetUri": "text",
      "permissions": {
        "role": "text",
        "canView": true,
        "canEdit": true,
        "canIssue": true,
        "canRevoke": true,
        "canManagePermissions": true,
        "canIssueChildren": "text",
        "canCreateChildren": "text",
        "canEditChildren": "text",
        "canRevokeChildren": "text",
        "canManageChildrenPermissions": "text",
        "canManageChildrenProfiles": true,
        "canViewAnalytics": true
      }
    }
  },
  "uri": "text"
}

{
  "cursor": "text",
  "hasMore": true,
  "records": [
    {
      "id": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "type": "text",
      "data": {
        "claimUri": "text",
        "targetUri": "text",
        "permissions": {
          "role": "text",
          "canView": true,
          "canEdit": true,
          "canIssue": true,
          "canRevoke": true,
          "canManagePermissions": true,
          "canIssueChildren": "text",
          "canCreateChildren": "text",
          "canEditChildren": "text",
          "canRevokeChildren": "text",
          "canManageChildrenPermissions": "text",
          "canManageChildrenProfiles": true,
          "canViewAnalytics": true
        }
      }
    }
  ]
}

Delete a Claim Hook

post

This route deletes a claim hook

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

idstringRequired

Responses

200

Successful response

application/json

booleanOptional

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/claim-hook/update

HTTPcURLJavaScriptPython

POST /api/claim-hook/update HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "id": "text"
}

true