Test

client.Webhooks.Test(ctx, id, body) (*, error)

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

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

Parameters

idstring

The id field.

body

Hide ParametersShow Parameters

Bodyfield

optional

param.Field[any]

The WebhooksServiceTestRequest message.

Returns

WebhookTestResponsestruct

The WebhooksServiceTestResponse message.

Hide ParametersShow Parameters

Webhook

optional

The WebhookInstance message.

Hide ParametersShow Parameters

IDstring

optional

The id field.

Attemptsint64

optional

The attempts field.

formatint32

CompletedAtTime

optional

formatdate-time

CreatedAtTime

optional

formatdate-time

ExpiresAtTime

optional

formatdate-time

LastAttemptedAtTime

optional

formatdate-time

Source

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

ApprovalStep

optional

The WebhookSourceApprovalStep message.

Hide ParametersShow Parameters

TicketIDstring

optional

The ticketId field.

PolicyPostAction

optional

The WebhookSourcePolicyPostAction message.

Hide ParametersShow Parameters

TicketIDstring

optional

The ticketId field.

ProvisionStep

optional

The WebhookSourceProvisionStep message.

Hide ParametersShow Parameters

TicketIDstring

optional

The ticketId field.

Testany

optional

The WebhookSourceTest message.

WorkflowStep

optional

The WebhookSourceWorkflowStep message.

Hide ParametersShow Parameters

WorkflowExecutionIDstring

optional

The workflowExecutionId field.

formatint64

WorkflowStepIDstring

optional

The workflowStepId field.

Spec

optional

The WebhookSpec message.

Hide ParametersShow Parameters

Destinationstring

optional

The destination field.

Statestring

optional

The state field.

Hide ParametersShow Parameters

WebhookTestResponseWebhookStateWebhookStateUnspecifiedconst

"WEBHOOK_STATE_UNSPECIFIED"

WebhookTestResponseWebhookStateWebhookStatePendingconst

"WEBHOOK_STATE_PENDING"

WebhookTestResponseWebhookStateWebhookStateRunningconst

"WEBHOOK_STATE_RUNNING"

WebhookTestResponseWebhookStateWebhookStateErrorconst

"WEBHOOK_STATE_ERROR"

WebhookTestResponseWebhookStateWebhookStateWaitingCallbackconst

"WEBHOOK_STATE_WAITING_CALLBACK"

WebhookTestResponseWebhookStateWebhookStateProcessResponseconst

"WEBHOOK_STATE_PROCESS_RESPONSE"

WebhookTestResponseWebhookStateWebhookStateSuccessconst

"WEBHOOK_STATE_SUCCESS"

WebhookTestResponseWebhookStateWebhookStateFatalErrorconst

"WEBHOOK_STATE_FATAL_ERROR"

UpdatedAtTime

optional

formatdate-time

WebhookIDstring

optional

The webhookId field.

Request example Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Webhooks.Test(
    context.TODO(),
    "id",
    conductoronesdk.WebhookTestParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Webhook)
}

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"
  }
}