Test

Test

post/api/v1/webhooks/{id}/test

Invokes the c1.api.webhooks.v1.WebhooksService.Test method.

Path Parameters

idstring

The id field.

Body Parameters

bodyunknown

optional

The WebhooksServiceTestRequest message.

Returns

webhookobject

optional

The WebhookInstance message.

Hide ParametersShow Parameters

idstring

optional

The id field.

attemptsnumber

optional

The attempts field.

formatint32

completedAtstring

optional

formatdate-time

createdAtstring

optional

formatdate-time

expiresAtstring

optional

formatdate-time

lastAttemptedAtstring

optional

formatdate-time

sourceobject

optional

The WebhookSource message.

This message contains a oneof named source. Only a single field of the following list may be set at a time:

• test
• policyPostAction
• approvalStep
• provisionStep
• workflowStep

Hide ParametersShow Parameters

approvalStepobject

optional

The WebhookSourceApprovalStep message.

Hide ParametersShow Parameters

ticketIdstring

optional

The ticketId field.

policyPostActionobject

optional

The WebhookSourcePolicyPostAction message.

Hide ParametersShow Parameters

ticketIdstring

optional

The ticketId field.

provisionStepobject

optional

The WebhookSourceProvisionStep message.

Hide ParametersShow Parameters

ticketIdstring

optional

The ticketId field.

testunknown

optional

The WebhookSourceTest message.

workflowStepobject

optional

The WebhookSourceWorkflowStep message.

Hide ParametersShow Parameters

workflowExecutionIdstring

optional

The workflowExecutionId field.

formatint64

workflowStepIdstring

optional

The workflowStepId field.

specobject

optional

The WebhookSpec message.

Hide ParametersShow Parameters

destinationstring

optional

The destination field.

stateenum

optional

"WEBHOOK_STATE_UNSPECIFIED" OR "WEBHOOK_STATE_PENDING" OR "WEBHOOK_STATE_RUNNING" OR 5 more

The state field.

Hide ParametersShow Parameters

"WEBHOOK_STATE_UNSPECIFIED"

"WEBHOOK_STATE_PENDING"

"WEBHOOK_STATE_RUNNING"

"WEBHOOK_STATE_ERROR"

"WEBHOOK_STATE_WAITING_CALLBACK"

"WEBHOOK_STATE_PROCESS_RESPONSE"

"WEBHOOK_STATE_SUCCESS"

"WEBHOOK_STATE_FATAL_ERROR"

updatedAtstring

optional

formatdate-time

webhookIdstring

optional

The webhookId field.

Request example cURL

curl https://{tenantDomain}.conductor.one/api/v1/webhooks/$ID/test \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"

200 Example

{
  "webhook": {
    "id": "id",
    "attempts": 0,
    "source": {
      "approvalStep": {
        "ticketId": "ticketId"
      },
      "policyPostAction": {
        "ticketId": "ticketId"
      },
      "provisionStep": {
        "ticketId": "ticketId"
      },
      "test": {},
      "workflowStep": {
        "workflowExecutionId": "workflowExecutionId",
        "workflowStepId": "workflowStepId"
      }
    },
    "spec": {
      "destination": "destination"
    },
    "state": "WEBHOOK_STATE_UNSPECIFIED",
    "webhookId": "webhookId"
  }
}