---
title: "Subscribe to events published by CRM app."
method: POST
path: "/v1/subscribe"
tags: ["CRM"]
---

# Subscribe to events published by CRM app.

`POST /v1/subscribe`

This endpoint is only required if you app does not have another method to register the CRM events callback during  installation.

## Headers

- `X-Hub-Signature-256` string, required

## Request body

- SubscribeRequest
  - `url` string, uri, required — Webhook url to register. This MUST be https or the request should be rejected.
  - `metadata` CRMMetadata, required
    - `id` string, crm-id, required — CRM integration ID
    - `instanceUrl` string, uri, required — The instance URL provided by the customer
    - `sharedKey` SharedKey, required
      - `key` string, byte, required — base64-encoded shared secret that is GCM-AES256-encrypted using `nonce` and application shared key
      - `nonce` string, byte, required — base64-encoded nonce value
    - `expiresAt` string, date-time, required — Expiry time for the request

## Response `201`

successful operation

---

[API](https://skmtc.net/hootsuite/apis/hootsuite-apps-api.md) · [All operations](https://skmtc.net/hootsuite/apis/hootsuite-apps-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hootsuite/hootsuite-apps-api/versions/015e2672e012/schema)