SMsmartling
Webhooks

Create subscription

Changed on

Create a new webhook subscription for the specified account.

post/webhooks-api/v2/accounts/{accountUid}/subscriptions

Request

  • Base URL
    https://api.smartling.com
  • Auth
    HTTP bearer

Path parameters

accountUidstring required

The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API.

Request body

subscriptionNamestring required

Display name for the subscription.

subscriptionUrlstring required

HTTPS endpoint that will receive webhook deliveries.

descriptionstring

Human-readable description.

payloadSecretstring

Secret used to sign webhook deliveries.

projectUidsProjectUid[]

Optional array of unique project identifiers. If no ids are provided, all projects in the account are included by default.

Example request

{
  "subscriptionName": "SourceIssue Created Subscription",
  "subscriptionUrl": "https://myurl.com/webhooks",
  "description": "My subscription",
  "payloadSecret": "mySuperLongAndSecurePayloadSecret",
  "requestHeaders": [
    {
      "headerName": "CustomHeader1",
      "headerValue": "HeaderValue1"
    }
  ],
  "events": [
    {
      "type": "sourceIssue.comment.created",
      "schemaVersion": "1.0"
    }
  ],
  "projectUids": [
    "84c012a33"
  ]
}

Response

Success

Example response

{
  "response": {
    "data": {
      "subscriptionUid": "111122223333",
      "subscriptionName": "SourceIssue Created Subscription",
      "subscriptionUrl": "https://myurl.com/webhooks",
      "accountUid": "111222333",
      "enabled": true,
      "userUid": "99b0662fbae1",
      "description": "My subscription",
      "createdDate": "2026-01-15T10:00:00Z",
      "requestHeaders": [
        {
          "headerName": "CustomHeader1",
          "headerValue": "HeaderValue1"
        }
      ],
      "events": [
        {
          "type": "sourceIssue.comment.created",
          "schemaVersion": "1.0"
        }
      ],
      "projectUids": [
        "111222333"
      ]
    }
  }
}

Changes