Docs Memory API

Receive events from another system

A webhook source gives another system a URL to post events to. Auld verifies, filters and maps each event into a record. Available on Flex and Enterprise.

#Create a source

Request

curl -X POST "$AULD_API_BASE/v1/sources" \
  -H "Authorization: Bearer $AULD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "helpdesk", "filter": "event.type in [\"ticket.created\", \"ticket.commented\"]",
        "mapping": { "sourceId": "ticket-{{ticket.id}}-{{event.id}}", "text": "{{comment.body}}",
                     "occurredAt": "{{event.created_at}}", "author": "{{comment.author_id}}",
                     "visibility": "audience:cust-{{ticket.org_id}}" } }'

201 Created

{ "sourceId": "src_hd…", "url": "https://YOUR-AULD-HOST/v1/sources/src_hd…/events", "signingSecret": "whsec_…" }

#Point the other system at it

Paste the URL into the sending system’s webhook settings. If it supports signing, configure the secret; otherwise keep the URL private and rotate it if exposed.

#Filters and mapping

The filter decides which events become records; the mapping turns event fields into record fields with {{path}} templates. Events that fail the filter are acknowledged and dropped.

#Billing

Every received event costs 0.1 credit, including events the filter drops. Events that are ingested also pay their payload credits. The estimator assumes one event in five is ingested.

#Inspecting deliveries

GET /v1/sources/{id}/events lists recent deliveries with their filter result and the job id of any record created.