POST
/
webhooks
/
invoke
curl --request POST \
  --url https://api-sandbox.orum.io/webhooks/invoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '{
  "event_type": "person_created",
  "data": {
    "customer_reference_id": "<string>",
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "<string>",
    "social_security_number": "<string>",
    "addresses": [
      {
        "type": "home",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "zip5": "<string>"
      }
    ],
    "contacts": [
      {
        "type": "email",
        "value": "<string>"
      }
    ]
  }
}'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Orum-Version
enum<string>
required

Version of Deliver API. Use v2022-09-21.

Available options:
v2022-09-21

Body

application/json
​
event_type
enum<string>
required

The type of event you want to invoke a webhook for.

Available options:
person_created,
person_verified,
person_rejected,
person_restricted,
person_unverified,
person_closed
​
data
object
required

Response

201

201 response.

Was this page helpful?

Delete Webhook ConfigurationOverview