Create a Hook

POST/lokta-lms/api/v1/hooks

Creates a hook that pushes platform events to another system.

Request body application/json

configobject · optional

displayNamestring · optional

eventsarray of HookEventData · optional

isActiveboolean · optional

namestring · optional

Responses

defaultdefault response

Response fields

resourceIdinteger · int64 · optional

Every request authenticates with HTTP Basic and carries a Tenant-Identifier header. See the conventions for dates, commands, pagination and errors. Open this operation in the interactive explorer, or read it as Markdown.

This is the API reference for Lokta, the agentic loan servicing platform. Go to lokta.ai

curl -X POST \ 'https://default.lokta.tech/lokta-lms/api/v1/hooks' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "config": {}, "displayName": "string", "events": [ { "actionName": "string", "entityName": "string" } ], "isActive": true, "name": "string" }'

import requests response = requests.post( "https://default.lokta.tech/lokta-lms/api/v1/hooks", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "config": {}, "displayName": "string", "events": [ { "actionName": "string", "entityName": "string" } ], "isActive": True, "name": "string" }, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/hooks", { method: "POST", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "config": {}, "displayName": "string", "events": [ { "actionName": "string", "entityName": "string" } ], "isActive": true, "name": "string" }), }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://default.lokta.tech/lokta-lms/api/v1/hooks")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(""" { "config": {}, "displayName": "string", "events": [ { "actionName": "string", "entityName": "string" } ], "isActive": true, "name": "string" } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "config": {}, "displayName": "string", "events": [ { "actionName": "string", "entityName": "string" } ], "isActive": true, "name": "string" }`) req, _ := http.NewRequest("POST", "https://default.lokta.tech/lokta-lms/api/v1/hooks", payload) req.SetBasicAuth("{username}", "{password}") req.Header.Set("Tenant-Identifier", "default") req.Header.Set("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data))