url-verification

This is for Cord to verify ownership of the Event Webhook URL you provided, and for you to confirm that your configuration is at least minimally working.

Payload #

The event payload consists only of a string to aid debugging, which you can ignore.

Verifying events webhook URL #

Whenever you save a new events webhook URL via the Cord Console or set it through the API, a URL verification process will be triggered to ensure ownership of the URL and to check the URL works. We will attempt to send the following HTTP POST request to your URL:

projectID: 'your-project-id',
event: { message: 'Please respond with a HTTP 200 status code.' },
timestamp: '1714280897844',
type: 'url-verification'

projectID: 'your-project-id',
event: { message: 'Please respond with a HTTP 200 status code.' },
timestamp: '1714280897844',
type: 'url-verification'

Once you receive this event, verify the incoming event then respond with a HTTP 200 status code:

import { validateWebhookSignature } from '@cord-sdk/server';

validateWebhookSignature(req, <YOUR_CORD_PROJECT_SIGNING_SECRET>);
if (req.body.type === 'url-verification') {
  res.sendStatus(200);
  return;
}

import { validateWebhookSignature } from '@cord-sdk/server';

validateWebhookSignature(req, <YOUR_CORD_PROJECT_SIGNING_SECRET>);
if (req.body.type === 'url-verification') {
  res.sendStatus(200);
  return;
}

The connection will be open for three seconds, during which time your app should respond to the request. If no response is received within three seconds, the verification process will fail and you will have to try again.