GuidesChangelog

Register for webhook events

Suggest Edits

Base Address

POST /Hooks/v2/Registrations

Use this call to:

  • Create a registration to webhook events
  • Edit a webhook registration
  • Restart a registration if it is suspended
Request URL
https:// .../Hooks/v2/Registrations

Sample request in cURL - POST /Hooks/v2/Registrations

In the request below, hookName shows the event registered as LoanStatusUpdated

curl --location --request POST 'https://lendingsandbox.crbcos.com/Hooks/v2/Registrations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <Token>' \
--data-raw '{
  "id": null,
  "applicationName": "Cos.Lending",
  "hookName": "LoanStatusUpdated",
  "hookCorrelationId": "Your 3 letter MPL ID",
  "options": {
    "hookType": "Web",
    "httpMethod": "POST",
    "uri": "Add your URL here, that is specific to this event type",
    "headers": {
      "headerName": [
        "LoanStatusUpdated"
      ]
    },
    "authenticationOptions": {
      "authenticationType": "None"
    }
  }, 
  "suspended": false
}'

🚧

Duplicate Registrations

The default behavior for hooks registration, is to either create or update the registration based on the MPLID and the hookName, assuming there is only one registration per combination of Mplid/hookName. In certain use cases, you might want to create two registrations for the same event. For example, one web hook, and one email hook. To do this, you need to supply a new Guid for the Id field of the registration.

Webhook attributes

AttributeDescription
id
string		This field can be null or populated with the registration GUID for the registration.

null - when creating a new registration
GUID - when updating or unsuspending an existing registration
applicationName
string		Should always be Cos.Lending
hookName
string		The name of the hook you want to register for.
- LoanStatusUpdated
- ComplianceLoanFailed
- RailUpdated
hookCorrelationId
string		3-letter MPL ID.
suspended
boolean		True or false.

True if the registration should be suspended and not send webhooks. False if the registration should be active.

If you edit a suspended registration, false will restart the registration.
options
object		Select the relevant values for the fields below.
options.hookTypeDelivery method for the event (enum). Select from:
- Web (for webhooks)
- Message (coming soon)
- RabbitMq (coming soon)
- Sqs (coming soon)
- Email (coming soon)
- Slack (coming soon)
options.httpMethod
string		POST
options.uri
string		The URL to receive webhook events.
options.headers
string array		Key/Value pairs of Headers and values.
options.authenticationOptions
object		Authentication options for web hooks. Select from:
- None
- Basic
- oidc

Sample response in JSON - POST /Hooks/v2/Registrations

Use the id received in the response to update or restart the registration. 

{
    "Version": "2.0",
    "IsSuccessful": true,
    "StatusCode": 200,
    "Result": {
        "id": "eb62ffbd-7ed4-4146-be48-7f2a46551c0e",
        "applicationName": "cos.lending",
        "hookName": "LoanStatusUpdated",
          ...
        ...
        ..
    }
}

Webhooks without Authentication

"options": {
    "hookType": "Web",
    "httpMethod": "POST",
    "uri": "Add your URL here, that is specific to this event type",
    "headers": {
      "headerName": [
        "Any Header you want to add to all events"
      ]
    },
    "authenticationOptions": {
      "authenticationType": "None"
    }
  }

Webhooks with Basic Authentication

"options": {
    "hookType": "Web",
    "httpMethod": "POST",
    "uri": "Add your URL here, that is specific to this event type",
    "headers": {
      "headerName": [
        "Any Header you want to add to all events"
      ]
    },
    "authenticationOptions": {
      "authenticationType": "Basic",
      "username": "yyy",
      "password": "1234"
    }
  }

Webhooks with OIDC Authentication

OpenID Connect using your own authentication authority.

"options": {
    "hookType": "Web",
    "httpMethod": "POST",
    "uri": "Add your URL here, that is specific to this event type",
    "headers": {
      "headerName": [
        "headerValue"
      ]
    },
    "authenticationOptions": {
        "authenticationType": "Oidc",
        "authorityUrl": "",
        "clientId": "",
        "clientSecret": "",
        "scope": ""
    }
  }

Testing webhook registration

To test registering webhooks, configure a URL for the specific event you are registering to. If a URL is not yet available, then you can use the webhook.site as a temporary test solution. Follow these instructions to test the webhooks.

To register your URL to receive webhook events:

  1. Go to https://webhook.site.
  2. Click New on the top menu.
    The site returns Your unique URL.
  3. Copy to clipboard your unique URL.

Note: If you already have other webhooks registered, the browser might automatically direct you to the URL you've used.

1487
  1. Paste the copied URL, into the options.uri field of the JSON body.
  2. Send the Registration API call, with hook type "web", to register for webhooks.

The response field Result.id is the RegistrationId of the event. You can find the registration ID with the call,
GET Hooks/v2/Registrations

Repeat the process for each event that you want to register for.

Updated 5 months ago