Skip to main content

CreateSubscriptionBody

publicationUrlPublicationUrl (string)required

The fully qualified URL to publish events to. The web server URL must be able to handle HTTP POST. It will be receiving x-www-form-urlencoded data not JSON.

topicsTopics (string)required

String Value of topics to subscribe to.

encryptEncrypt (boolean)

If true, will encrypt the event messages using the supplied Shared Key. Encryption will be AES 128 or 256 depending on Shared Key length (16 bytes = 128 bit, 32 bytes = 256 bit). Encryption is not necessary if publishing to an https URL. Encrypted MSG is Base64 encoded for transport purposes, therefore you must base64 decode the MSG before decrypting it. MSG plaintext will be in JSON format.

sharedKeySharedKey (string)

If specified, all event messages will be emitted with an HMAC using this key to guarantee message authenticity, and optionally encrypted using this key (if encrypt = true).

CreateSubscriptionBody
{
  "publicationUrl": "string",
  "topics": "string",
  "encrypt": true,
  "sharedKey": "string"
}