Register for hooks

17min

﻿Base Address﻿
﻿https://lendingsandbox.crbcos.com/﻿
Registrations can also be created, updated, and restarted via the Cos.Lending.Hooks UI:
Sandbox UI: https://lendingappsandbox.crbcos.com/hooks/registrations﻿
Production UI: https://lendingapp.crbcos.com/hooks/registrations﻿
﻿
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
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
}'
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
}'
﻿
Duplication 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
Attribute
Description
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.hookType
Delivery method for the event (enum).
Select from:
- Web (for webhooks)
- Email  
- Slack 
- Message (coming soon)
- RabbitMq (coming soon)
- Sqs (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.
Each header can have an array of values:
"Headers": {
"FirstHeader": [
"test1",
"test2"
],
"secondHeader":["single value"]
}
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.
JSON
{
    "Version": "2.0",
    "IsSuccessful": true,
    "StatusCode": 200,
    "Result": {
        "id": "eb62ffbd-7ed4-4146-be48-7f2a46551c0e",
        "applicationName": "cos.lending",
        "hookName": "LoanStatusUpdated",
          ...
        ...
        ..
    }
}
{
    "Version": "2.0",
    "IsSuccessful": true,
    "StatusCode": 200,
    "Result": {
        "id": "eb62ffbd-7ed4-4146-be48-7f2a46551c0e",
        "applicationName": "cos.lending",
        "hookName": "LoanStatusUpdated",
          ...
        ...
        ..
    }
}
﻿
Webhooks without Authentication
JSON
"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"
    }
  }
"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
JSON
"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"
    }
  }
"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.
OIDC setup must be implemented first
Your OIDC must be fully implemented in order to use Hooks notifications with OIDC authentication. 
This includes setting up a discovery endpoint /.well-known/openid-configuration
JSON
"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": ""
    }
  }
"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": ""
    }
  }
﻿
Slack hook registration
Hook events can also be sent to your slack channels. To do this you must:
Create a slack bot with permissions to write to a channel in your workspace.
Retrieve the auth token of the slackbot.
Add the slackbot to the slack channel that you wish to register.
Register the channel to receive events on the Cos.Lending.Hooks UI, or via the API payload below.
IMPORTANT
Registering to a slack channel is not recommended if automation is needed. For complete automation, it is recommended to use "web" hooks instead. 
﻿
JSON
{
  "id": null,
  "applicationName": "Cos.Lending",
  "hookName": "LoanNoteAdded",
  "hookCorrelationId": "Your 3 letter MPL ID",
   "options": {
    "hookType": "Slack",
    "authToken": "Your Slack API bot token.",
    "channel": "The channel name. You must also add your slack bot to this channel"
    },
  "suspended": false
}
{
  "id": null,
  "applicationName": "Cos.Lending",
  "hookName": "LoanNoteAdded",
  "hookCorrelationId": "Your 3 letter MPL ID",
   "options": {
    "hookType": "Slack",
    "authToken": "Your Slack API bot token.",
    "channel": "The channel name. You must also add your slack bot to this channel"
    },
  "suspended": false
}
﻿
Email hook registration
Hook events can also be sent to your Email address, or group email address. 
Register the channel to receive events on the Cos.Lending.Hooks UI, or via the API payload below.
IMPORTANT
Registering to receive events via email is not recommended if automation is needed. For complete automation, it is recommended to use "web" hooks instead. 
﻿
JSON
{
  "id": null,
  "applicationName": "Cos.Lending",
  "hookName": "LoanNoteAdded",
  "hookCorrelationId": "Your 3 letter MPL ID",
    "options": {
                    "hookType": "Email",
                    "to": [
                        "email address"
                    ],
                    "cc": [
                        null
                    ],
                    "bcc": [
                        null
                    ]
                },
  "suspended": false
}
{
  "id": null,
  "applicationName": "Cos.Lending",
  "hookName": "LoanNoteAdded",
  "hookCorrelationId": "Your 3 letter MPL ID",
    "options": {
                    "hookType": "Email",
                    "to": [
                        "email address"
                    ],
                    "cc": [
                        null
                    ],
                    "bcc": [
                        null
                    ]
                },
  "suspended": false
}
﻿
﻿
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:
Go to https://webhook.site/﻿
Click New on the top menu. The site returns Your unique URL.
Copy to clipboard your unique URL.
If you already have other webhooks registered, the browser might automatically direct you to the URL you've used.
﻿
﻿
    4. Paste the copied URL into the options.uri field of the JSON body.
    5. 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.

🤔

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.

﻿

Updated 08 Oct 2024

Did this page help you?

Hook notifications

Webhook events

Attribute	Description
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.hookType	Delivery method for the event (enum). Select from: - Web (for webhooks) - Email - Slack - Message (coming soon) - RabbitMq (coming soon) - Sqs (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. Each header can have an array of values: "Headers": { "FirstHeader": [ "test1", "test2" ], "secondHeader":["single value"] }
options.authenticationOptions object	Authentication options for web hooks. Select from: - None - Basic - oidc

Register for hooks

POST /Hooks/v2/Registrations

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

Webhook attributes

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

Webhooks without Authentication

Webhooks with Basic Authentication

Webhooks with OIDC Authentication

Slack hook registration

Email hook registration

﻿

Testing webhook registration

To register your URL to receive webhook events: