Help Center/ EventGrid/ API Reference/ APIs/ Event Subscription Management/ Creating an Event Subscription Target
Updated on 2023-05-24 GMT+08:00
View PDF

Creating an Event Subscription Target

Function

This API is used to create an event subscription target.

URI

POST /v1/{project_id}/subscriptions/{subscription_id}/targets

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant project ID.

subscription_id

Yes

String

ID of the event subscription.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Minimum: 1

Maximum: 16384
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

id

No

String

Subscription target ID. The value must be globally unique. Only lowercase letters, digits, and hyphens (-) are allowed. It must start with a letter or digit. In the subscription update scenario, if the subscription target with the specified ID exists, the subscription target is updated. Otherwise, the subscription target is created. If no ID is specified, the system automatically generates an ID when creating the subscription target. If an ID is specified, the ID is used as the subscription target ID. This field is ignored when the subscription target is updated.

Minimum: 32

Maximum: 64

name

Yes

String

Name of the event subscription target.

Maximum: 128

provider_type

Yes

String

Provider type of the event subscription target.

Enumeration values:

  • CUSTOM

  • OFFICIAL

connection_id

No

String

Connection ID used by the event subscription target.

Maximum: 64

detail

Yes

Object

List of event subscription target parameters. The total length of this field after serialization cannot exceed 1024 bytes.

transform

Yes

TransForm object

Transform rule of the event subscription target.
Table 4 TransForm

Parameter

Mandatory

Type

Description

type

Yes

String

Type of the transform rule.

Enumeration values:

  • ORIGINAL

  • CONSTANT

  • VARIABLE

value

No

String

For a constant type rule, the field is the constant content definition. For a variable type rule, the field is a variable definition and the content must be a JSON object string. A maximum of 100 variables are supported, and nested structures are not supported. The variable name can contain a maximum of 64 characters. Only letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. It must start with a letter or digit and cannot start with HC.. The variable value expression can be a constant or JSONPath expression. The string length cannot exceed 1024 characters.

Maximum: 1024

template

No

String

Template definition of the rule content when the rule is of the variable type. Defined variables can be referenced.

Maximum: 2048

Response Parameters

Status code: 200

Table 5 Response header parameters

Parameter

Type

Description

X-Request-Id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.
Table 6 Response body parameters

Parameter

Type

Description

id

String

ID of the event subscription target.

name

String

Name of the event subscription target.

provider_type

String

Provider type of the event subscription target.

connection_id

String

Connection ID used by the event subscription target.

Maximum: 64

detail

Object

List of event subscription target parameters.

transform

TransForm object

Transform rule of the event subscription target.

created_time

String

Time when the event subscription is created.

updated_time

String

Time when the event subscription is updated.
Table 7 TransForm

Parameter

Type

Description

type

String

Type of the transform rule.

Enumeration values:

  • ORIGINAL

  • CONSTANT

  • VARIABLE

value

String

For a constant type rule, the field is the constant content definition. For a variable type rule, the field is a variable definition and the content must be a JSON object string. A maximum of 100 variables are supported, and nested structures are not supported. The variable name can contain a maximum of 64 characters. Only letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. It must start with a letter or digit and cannot start with HC.. The variable value expression can be a constant or JSONPath expression. The string length cannot exceed 1024 characters.

Maximum: 1024

template

String

Template definition of the rule content when the rule is of the variable type. Defined variables can be referenced.

Maximum: 2048

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Status code: 403

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Status code: 404

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Example Requests

Create an event subscription target.

/v1/{project_id}/subscriptions/{subscription_id}/targets

{
  "id" : null,
  "name" : "HTTPS",
  "provider_type" : "CUSTOM",
  "detail" : {
    "url" : "https://www.ccc.com"
  },
  "transform" : {
    "type" : "ORIGINAL",
    "value" : ""
  }
}

Example Responses

Status code: 400

{
  "error_code" : "EG.00014000",
  "error_msg" : "Bad request"
}

Status code: 401

{
  "error_code" : "EG.00014010",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

{
  "error_code" : "EG.00014030",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

{
  "error_code" : "EG.00014040",
  "error_msg" : "Not request resource found"
}

Status code: 500

{
  "error_code" : "EG.00015000",
  "error_msg" : "Internal Server Error"
}

Status Codes

Status Code

Description

200

Information

400

Invalid request.

401

Unauthorized.

403

Access denied.

404

Resource not found.

500

Internal service error.

Error Codes

See Error Codes.