Starfish API Documentation

updateWebhookSubscription

Updates subscription webhook. Requires advanced API access level.

UpdateWebhookSubscriptionMutationInput

Autogenerated input type of UpdateWebhookSubscriptionMutation

  • clientMutationId: String

    A unique identifier for the client performing the mutation.

  • id: ID!required

    The ID of the webhook to update

  • webhookUrl: Url

    The URL of the endpoint on your server to be notified when the event occurs

  • secret: String

    The secret used to sign the JWT in the webhook request

  • query: String

    The query containing the subscription and fields required by the webhook endpoint

UpdateWebhookSubscriptionMutationPayload

Autogenerated return type of UpdateWebhookSubscriptionMutation.

Query

mutation($input: UpdateWebhookSubscriptionMutationInput!) {
  updateWebhookSubscription(input: $input) {
    webhookSubscription {
      id
      webhookUrl
      query
    }
  }
}

Variables

{
  "input": {
    "id": "WebhookSubscription-67W4CR",
    "webhookUrl": "http://new/url",
    "secret": "new_secret",
    "query": "subscription { userCreated { emailAddress } }"
  }
}

Response

{
  "data": {
    "updateWebhookSubscription": {
      "webhookSubscription": {
        "id": "WebhookSubscription-67W4CR",
        "webhookUrl": "http://new/url",
        "query": "subscription { userCreated { emailAddress } }"
      }
    }
  }
}