Create external event mapping

Bind an inbound provider event to a stage sub-step. source and stepKey slug-normalize; eventType is the provider’s literal event name (“*” is a catch-all). The matcher resolves the payload at matchPath to the record’s externalId (deal/customer) or externalRef (issue).

POST/workspaces/{organizationId}/external-event-mappings

Path parameters

organizationIdstringrequired

Request body

application/json

sourcestringrequired

min length 1

eventTypestringrequired

min length 1

entityTypestringrequired

Allowed:issuedealcustomer

matchPathstringrequired

Dotted path into the event payload resolving to the record's external id — e.g. "data.merchant_id".

min length 1

stepKeystringrequired

min length 1

secretstringrequired

HMAC-SHA256 signing secret for this source's deliveries.

min length 1

enabledboolean

Responses

201

External event mapping created

mappingExternalEventMappingrequired

Show properties

idstringrequired

organizationIdstringrequired

sourcestringrequired

eventTypestringrequired

entityTypestringrequired

Allowed:issuedealcustomer

matchPathstringrequired

stepKeystringrequired

enabledbooleanrequired

createdBystring | nullrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

sourcestring*eventTypestring*entityTypestring*matchPathstring*Dotted path into the event payload resolving to the record's external id — e.g. "data.merchant_id".stepKeystring*secretstring*HMAC-SHA256 signing secret for this source's deliveries.enabledboolean

Request

curl -X POST '/workspaces/string/external-event-mappings' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "source": "string",
  "eventType": "string",
  "entityType": "issue",
  "matchPath": "string",
  "stepKey": "string",
  "secret": "string",
  "enabled": true
}'

const response = await fetch("/workspaces/string/external-event-mappings", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"source\": \"string\",\n  \"eventType\": \"string\",\n  \"entityType\": \"issue\",\n  \"matchPath\": \"string\",\n  \"stepKey\": \"string\",\n  \"secret\": \"string\",\n  \"enabled\": true\n}"
});

import requests

response = requests.post(
    "/workspaces/string/external-event-mappings",
    headers={
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"source\": \"string\",\n  \"eventType\": \"string\",\n  \"entityType\": \"issue\",\n  \"matchPath\": \"string\",\n  \"stepKey\": \"string\",\n  \"secret\": \"string\",\n  \"enabled\": true\n}",
)

Response

{
  "mapping": {
    "id": "string",
    "organizationId": "string",
    "source": "string",
    "eventType": "string",
    "entityType": "issue",
    "matchPath": "string",
    "stepKey": "string",
    "enabled": true,
    "createdBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}