Bagikan melalui


WebHookActivity interface

Aktivitas WebHook.

Memperluas

Properti

authentication

Metode autentikasi yang digunakan untuk memanggil titik akhir.

body

Mewakili payload yang akan dikirim ke titik akhir. Diperlukan untuk metode POST/PUT, tidak diizinkan untuk Jenis metode GET: string (atau Ekspresi dengan string resultType).

headers

Mewakili header yang akan dikirim ke permintaan. Misalnya, untuk mengatur bahasa dan jenis pada permintaan: "header" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Jenis: string (atau Ekspresi dengan string resultType).

method

Metode Rest API untuk titik akhir target.

policy

Kebijakan aktivitas.

reportStatusOnCallBack

Ketika diatur ke true, statusCode, output, dan kesalahan dalam isi permintaan panggilan balik akan dikonsumsi oleh aktivitas. Aktivitas dapat ditandai sebagai gagal dengan mengatur statusCode >= 400 dalam permintaan panggilan balik. Secara default adalah false. Jenis: boolean (atau Ekspresi dengan resultType boolean).

timeout

Batas waktu di mana webhook harus dipanggil kembali. Jika tidak ada nilai yang ditentukan, nilai defaultnya adalah 10 menit. Jenis: string. Pola: ((\d+).)? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])).

type

Diskriminator polimorfik, yang menentukan berbagai jenis objek ini dapat

url

Titik akhir dan jalur target aktivitas WebHook. Jenis: string (atau Ekspresi dengan string resultType).

Properti yang Diwariskan

dependsOn

Aktivitas tergantung pada kondisi.

description

Deskripsi aktivitas.

name

Nama aktivitas.

onInactiveMarkAs

Hasil status aktivitas saat status diatur ke Tidak Aktif. Ini adalah properti opsional dan jika tidak disediakan saat aktivitas tidak aktif, status akan Berhasil secara default.

state

Status aktivitas. Ini adalah properti opsional dan jika tidak disediakan, statusnya akan Aktif secara default.

userProperties

Properti pengguna aktivitas.

Detail Properti

authentication

Metode autentikasi yang digunakan untuk memanggil titik akhir.

authentication?: WebActivityAuthentication

Nilai Properti

body

Mewakili payload yang akan dikirim ke titik akhir. Diperlukan untuk metode POST/PUT, tidak diizinkan untuk Jenis metode GET: string (atau Ekspresi dengan string resultType).

body?: any

Nilai Properti

any

headers

Mewakili header yang akan dikirim ke permintaan. Misalnya, untuk mengatur bahasa dan jenis pada permintaan: "header" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Jenis: string (atau Ekspresi dengan string resultType).

headers?: {[propertyName: string]: any}

Nilai Properti

{[propertyName: string]: any}

method

Metode Rest API untuk titik akhir target.

method: string

Nilai Properti

string

policy

Kebijakan aktivitas.

policy?: SecureInputOutputPolicy

Nilai Properti

reportStatusOnCallBack

Ketika diatur ke true, statusCode, output, dan kesalahan dalam isi permintaan panggilan balik akan dikonsumsi oleh aktivitas. Aktivitas dapat ditandai sebagai gagal dengan mengatur statusCode >= 400 dalam permintaan panggilan balik. Secara default adalah false. Jenis: boolean (atau Ekspresi dengan resultType boolean).

reportStatusOnCallBack?: any

Nilai Properti

any

timeout

Batas waktu di mana webhook harus dipanggil kembali. Jika tidak ada nilai yang ditentukan, nilai defaultnya adalah 10 menit. Jenis: string. Pola: ((\d+).)? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])).

timeout?: string

Nilai Properti

string

type

Diskriminator polimorfik, yang menentukan berbagai jenis objek ini dapat

type: "WebHook"

Nilai Properti

"WebHook"

url

Titik akhir dan jalur target aktivitas WebHook. Jenis: string (atau Ekspresi dengan string resultType).

url: any

Nilai Properti

any

Detail Properti yang Diwariskan

dependsOn

Aktivitas tergantung pada kondisi.

dependsOn?: ActivityDependency[]

Nilai Properti

Diwarisi dariControlActivity.dependsOn

description

Deskripsi aktivitas.

description?: string

Nilai Properti

string

Diwarisi dariControlActivity.description

name

Nama aktivitas.

name: string

Nilai Properti

string

Diwarisi dari ControlActivity.name

onInactiveMarkAs

Hasil status aktivitas saat status diatur ke Tidak Aktif. Ini adalah properti opsional dan jika tidak disediakan saat aktivitas tidak aktif, status akan Berhasil secara default.

onInactiveMarkAs?: string

Nilai Properti

string

Diwarisi dariControlActivity.onInactiveMarkAs

state

Status aktivitas. Ini adalah properti opsional dan jika tidak disediakan, statusnya akan Aktif secara default.

state?: string

Nilai Properti

string

Diwarisi dariControlActivity.state

userProperties

Properti pengguna aktivitas.

userProperties?: UserProperty[]

Nilai Properti

Diwarisi dariControlActivity.userProperties