Webhook of Plan

POST

Please provide your URL for Webhook to us

When all the tasks of the plan end, we will actively notify the counterparty that the plan has ended. If this URL responds abnormally, we will retry at 1 minute intervals, and will not be notified after a maximum of 5 failed retries.
There are two parameters need for configuration
URL The URL for Webhook
KEY KEY for parameter sign, or airudder sign by default, see the sign description

请求参数

Header 参数

Content-Type

string

必需

默认值:

application/json

User-Agent

string

可选

默认值:

Airudder

Body 参数application/json

PlanName

string

必需

Name of the Plan

Timestamp

string

必需

The timestamp of request time.

PlanDetails

array [object {4}]

必需

The details of plan. Includes: rounds of tasks,name of tasks, ID of task and Status of tasks

Rounds

string

Rounds

必需

TaskName

string

TaskName

必需

TaskID

string

Task ID

必需

Status

enum<string>

必需

Task Status

枚举值:

createdpendingfinishedcallingcanceledpaused

Sign

string

必需

md5 sign value. You can verify the sign and process on the plan. It is not required to do verification.

Sign Rule：

Timestamp+KEY by utf-8 code

Use hexadecimal md5 to encrypt the value in step one

Lowercase. Case-sensitive.
Timestamp=1667903472 KEY=airudder
Expression = md5(Timestamp+KEY).hexdigest()
md5 value=13f3660caa70fcc4d89c6b77b1131cb2

示例

{
  "PlanName": "Bucket16-30_111111111ABC",
  "Timestamp": "1667903472",
  "Sign": "13f3660caa70fcc4d89c6b12345678",
  "PlanDetails": [
    {
      "TaskName": "Bucket16-30__111111111ABC_Round_1",
      "TaskID": "be80680638eba8ebb0000000",
      "Status": "finished",
      "Rounds": "1"
    },
    {
      "TaskName": "Bucket16-30__111111111ABC_Round_2",
      "TaskID": "86ab001c14bb4ef19323000000000",
      "Status": "finished",
      "Rounds": "2"
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'Please provide your URL for Webhook to us' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "PlanName": "Bucket16-30_111111111ABC",
    "Timestamp": "1667903472",
    "Sign": "13f3660caa70fcc4d89c6b12345678",
    "PlanDetails": [
        {
            "TaskName": "Bucket16-30__111111111ABC_Round_1",
            "TaskID": "be80680638eba8ebb0000000",
            "Status": "finished",
            "Rounds": "1"
        },
        {
            "TaskName": "Bucket16-30__111111111ABC_Round_2",
            "TaskID": "86ab001c14bb4ef19323000000000",
            "Status": "finished",
            "Rounds": "2"
        }
    ]
}'

返回响应

🟢200success

application/json

Body

object {0}

示例

{}

修改于 2024-12-17 11:00:59

Cancel a Certain Call in a Plan

Webhook of Task